@canboat/canboatjs 3.0.2 → 3.2.2

package/lib/canId.js

@@ -1,64 +0,0 @@
-const { flow } = require('lodash/fp')
-
-// Decode CAN Identifier (canId). ISO 11783 (CAN 2.0 B Extended Frame Format)
-exports.parseCanId = (id) => {
-  const res = {
-    canId: id, // Include original canId in return object.
-    prio: ((id >> 26) & 0x7), // Priority
-    src: id & 0xff, // Source Address (SA)
-  }
-  const PF = (id >> 16) & 0xff // PDU Format
-  const PS = (id >> 8) & 0xff // PDU Specific
-  const DP =  (id >> 24) & 1 // Data Page
-
-  if (PF < 240) {
-    /* PDU1 format, the PS contains the destination address */
-    res.dst = PS;
-    res.pgn = (DP << 16) + (PF << 8);
-  } else {
-    /* PDU2 format, the destination is implied global and the PGN is extended */
-    res.dst = 0xff
-    res.pgn = (DP << 16) + (PF << 8) + PS
-  }
-  return res
-}
-// canId should be a hex encoded string without spaces or commas.
-exports.parseCanIdStr = canId => exports.parseCanId(parseInt(canId, 16))
-
-exports.buildCanId = (prio, pgn, dst, src) => ({
-  prio: Number(prio),
-  pgn: Number(pgn),
-  dst: Number(dst),
-  src: Number(src),
-})
-
-// Encode CAN Identifier (canId)
-exports.encodeCanId = ({ dst, pgn, prio, src }) => {
-  let canId = src & 0xff
-
-  //I can't get this to work, but things seem ok??
-  //let canId = ((src & 0xff) | 0x80000000)) // src bits are the lowest ones of the CAN ID. Also set the highest bit to 1 as n2k uses
-  // only extended frames (EFF bit).
-
-  const PF = (pgn >> 8) & 0xff
-
-  if (PF < 240)
-  { // PDU 1
-    canId = (canId | ((dst & 0xff) << 8))
-    canId = (canId | (pgn << 8))
-  }
-  else
-  { // PDU 2
-    canId = (canId | pgn << 8)
-  }
-  canId = (canId | prio << 26)
-  
-  return canId 
-}
-exports.canIdString = canId => canId.toString(16).padStart(8, '0')
-exports.encodeCanIdString = flow(
-  exports.encodeCanId,
-  exports.canIdString,
-)
-// Utility function that parses and re-encodes. Compare result to original.
-exports.parseEncode = x => exports.encodeCanId(exports.parseCanId(x))

package/lib/canbus.js

@@ -1,278 +0,0 @@
-/**
- * Copyright 2018 Scott Bender (scott@scottbender.net)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const debug = require('debug')('canboatjs:canbus')
-const Transform = require('stream').Transform
-const isArray = require('lodash').isArray
-const BitStream = require('bit-buffer').BitStream
-const BitView = require('bit-buffer').BitView
-const { toPgn } = require('./toPgn')
-const Parser = require('./fromPgn').Parser
-const _ = require('lodash')
-const CanDevice = require('./candevice')
-const { getPlainPGNs, binToActisense } = require('./utilities')
-const { encodeCanId, parseCanId } = require('./canId')
-const { toActisenseSerialFormat, parseActisense } = require('./stringMsg')
-
-const MSG_BUF_SIZE  			= 2000
-const CANDUMP_DATA_INC_3		= 3
-const CANDUMP_DATA_INC_2		= 2
-const MAX_DATA_BYTES			= 223
-
-// There are at least three variations in candump output
-// format which are currently handled...
-//
-const FMT_TBD			= 0
-const FMT_1			= 1	// Angstrom ex:	"<0x18eeff01> [8] 05 a0 be 1c 00 a0 a0 c0"
-const FMT_2			= 2	// Debian ex:	"   can0  09F8027F   [8]  00 FC FF FF 00 00 FF FF"
-const FMT_3			= 3	// candump log ex:	"(1502979132.106111) slcan0 09F50374#000A00FFFF00FFFF"
-
-
-function CanbusStream (options) {
-  if (!(this instanceof CanbusStream)) {
-    return new CanbusStream(options)
-  }
-
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  this.plainText = false
-  this.options = options
-  this.start()
-
-  this.setProviderStatus = options.app && options.app.setProviderStatus
-    ? (msg) => {
-      options.app.setProviderStatus(options.providerId, msg)
-    }
-  : () => {}
-  this.setProviderError = options.app && options.app.setProviderError
-    ? (msg) => {
-      options.app.setProviderError(options.providerId, msg)
-    }
-  : () => {}
-  
-  if ( options.fromStdIn ) {
-    return
-  }
-
-  try {
-    this.socketcan = require('socketcan')
-  } catch ( err ) {
-    console.error(err)
-    var msg = 'unable to load native socketcan interface'
-    console.error(msg)
-  }
-
-  var that = this
-
-  if ( options.app ) {
-    options.app.on(options.outEvent || 'nmea2000out', (msg) => {
-      that.sendPGN(msg)
-    })
-    options.app.on(options.jsonOutEvent || 'nmea2000JsonOut', (msg) => {
-      that.sendPGN(msg)
-    })
-  }
-
-  var canDevice = options.canDevice || 'can0'
-  
-  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 ) {
-        }
-        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} );
-    this.channel.addListener('onStopped', (msg) => {
-      if ( this.channel ) { // stoped by us?
-        delete this.channel 
-        this.setProviderError('Stopped, Retrying...')
-        if ( this.options.app ) {
-          console.error('socketcan stopped, retrying...')
-        }
-        setTimeout(() => {
-          this.setProviderError('Reconnecting...')
-          this.connect()
-        }, 2000)
-      }
-    })
-    this.channel.addListener('onMessage', (msg) => {
-      var pgn = parseCanId(msg.id)
-
-      if ( this.noDataInterval ) {
-        this.lastDataReceived = Date.now()
-      }
-
-      //always send address claims through
-      if ( pgn.pgn != 60928 && that.candevice && that.candevice.cansend && pgn.src == that.candevice.address ) {
-        return
-      }
-
-      pgn.timestamp = new Date().toISOString()
-      if ( that.plainText ) {
-        this.push(binToActisense(pgn, msg.data, msg.data.length))
-      } else {
-        that.push({ pgn, length: msg.data.length, data: msg.data })
-      }
-    })
-    this.channel.start()
-    this.setProviderStatus('Connected to socketcan')
-    this.candevice = new CanDevice(this, this.options)
-    this.candevice.start()
-    return true
-  } catch (e) {
-    console.error(`unable to open canbus ${canDevice}: ${e}`)
-    console.error(e.stack)
-    this.setProviderError(e.message)
-    return false
-  }
-}
-
-require('util').inherits(CanbusStream, Transform)
-
-CanbusStream.prototype.start = function () {
-}
-
-CanbusStream.prototype.sendPGN = function (msg, force) {
-  if ( this.candevice ) {
-    //if ( !this.candevice.cansend && (_.isString(msg) || msg.pgn !== 59904) ) {
-    if ( !this.candevice.cansend && force !== true ) {
-      //we have not completed address claim yet
-      return
-    }
-
-    debug('sending %j', msg)
-
-    if ( this.options.app ) {
-      this.options.app.emit('connectionwrite', { providerId: this.options.providerId })
-    }
-
-    let src = msg.pgn === 59904 || msg.forceSrc ? msg.src : this.candevice.address
-    if ( _.isString(msg) ) {
-      var split = msg.split(',')
-      split[3] = src
-      msg = split.join(',')
-    } else {
-      msg.src = src
-      if ( _.isUndefined(msg.prio) ) {
-        msg.prio = 3
-      }
-      if ( _.isUndefined(msg.dst) ) {
-        msg.dst = 255
-      }
-    }
-
-    if ( this.socketCanWriter ) {
-      if ( _.isString(msg) ) {
-        this.socketCanWriter.stdin.write(msg + '\n')
-      } else {
-        var str = toActisenseSerialFormat(msg.pgn, toPgn(msg), msg.dst, msg.src)
-        this.socketCanWriter.stdin.write(str + '\n')
-      }
-    } else if ( this.channel  ) {
-      var canid
-      var buffer
-
-      var pgn
-      if ( _.isObject(msg) ) {
-        canid = encodeCanId(msg)
-        buffer = toPgn(msg)
-        pgn = msg
-      } else {
-        pgn = parseActisense(msg)
-        canid = encodeCanId(pgn)
-        buffer = pgn.data
-      }
-
-      if ( debug.enabled ) {
-        var str = toActisenseSerialFormat(pgn.pgn, buffer, pgn.dst, pgn.src)
-        debug(str)
-      }
-
-      //seems as though 126720 should always be encoded this way
-      if ( buffer.length > 8 || pgn.pgn == 126720 ) {
-        var pgns = getPlainPGNs(buffer)
-        pgns.forEach(pbuffer => {
-          this.channel.send({id: canid, ext:true, data: pbuffer})
-        })
-      } else {
-        this.channel.send({id: canid, ext:true, data: buffer})
-      }
-    }
-  }
-}
-
-
-CanbusStream.prototype._transform = function (chunk, encoding, done) {
-  done()
-}
-
-CanbusStream.prototype.end = function () {
-  if ( this.channel ) {
-    let channel = this.channel
-    delete this.channel
-    channel.stop()
-  }
-  if ( this.noDataInterval ) {
-    clearInterval(this.noDataInterval)
-  }
-}
-
-
-CanbusStream.prototype.pipe = function (pipeTo) {
-  if ( !pipeTo.fromPgn ) {
-    this.plainText = true
-  }
-  /*
-  pipeTo.fromPgn.on('pgn', (pgn) => {
-    if ( this.candevice ) {
-      this.candevice.n2kMessage(pgn)
-    }
-  })
-  */
-  return CanbusStream.super_.prototype.pipe.call(this, pipeTo)
-}
-
-
-module.exports = CanbusStream

package/lib/candevice.js

@@ -1,51 +0,0 @@
-/**
- * Copyright 2018 Scott Bender (scott@scottbender.net) and Jouni Hartikainen (jouni.hartikainen@iki.fi)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const debug = require('debug')('canboatjs:candevice')
-const EventEmitter = require('events')
-const _ = require('lodash')
-const Uint64LE = require('int64-buffer').Uint64LE
-const { defaultTransmitPGNs, getIndustryCode, getManufacturerCode, getDeviceClassCode } = require('./codes')
-const { toPgn } = require('./toPgn')
-const N2kDevice = require('./n2kDevice')
-
-let packageJson
-try
-{
-  packageJson = require('../' + 'package.json')
-} catch (ex) {
-}
-
-const deviceTransmitPGNs = [ 60928, 59904, 126996, 126464 ]
-
-class CanDevice extends N2kDevice {
-  constructor (canbus, options) {
-    super(options)
-    this.canbus = canbus
-
-    if ( options.app ) {
-      options.app.on(options.analyzerOutEvent || 'N2KAnalyzerOut', this.n2kMessage.bind(this))
-    }
-  }
-
-  sendPGN(pgn, src) {
-    pgn.src = src || this.address
-    debug('Sending PGN %j', pgn)
-    this.canbus.sendPGN(pgn, true)
-  }
-}
-
-module.exports = CanDevice

package/lib/codes.js

@@ -1,69 +0,0 @@
-const { invert, propertyOf } = require('lodash/fp')
-const manufacturerNames = require('./codesMfgs.json')
-
-const industryCodes = {
-  0: 'Global',
-  1: 'Highway',
-  2: 'Agriculture',
-  3: 'Construction',
-  4: 'Marine Industry',
-  5: 'Industrial'
-}
-
-const deviceClassCodes = {
-  0: 'Reserved for 2000 Use',
-  10: 'System tools',
-  20: 'Safety systems',
-  25: 'Internetwork device',
-  30: 'Electrical Distribution',
-  35: 'Electrical Generation',
-  40: 'Steering and Control surfaces',
-  50: 'Propulsion',
-  60: 'Navigation',
-  70: 'Communication',
-  75: 'Sensor Communication Interface',
-  80: 'Instrumentation/general systems',
-  85: 'External Environment',
-  90: 'Internal Environment',
-  100: 'Deck + cargo + fishing equipment systems',
-  120: 'Display',
-  125: 'Entertainment'
-}
-
-const deviceClassNames = invert(deviceClassCodes)
-const industryNames = invert(industryCodes)
-industryNames['Marine'] = 4
-
-const defaultTransmitPGNs = [
-  126992,
-  128267,
-  129794,
-  129038,
-  129041,
-  127505,
-  127506,
-  127508,
-  129026,
-  129025,
-  129029,
-  127250,
-  130306,
-  126720,
-  127489,
-  127488,
-  130311,
-  130312,
-  127257,
-  128259,
-  127502
-]
-
-const manufacturerCodes = invert(manufacturerNames)
-module.exports.manufacturerCodes = manufacturerCodes
-module.exports.getIndustryName = propertyOf(industryCodes)
-module.exports.getManufacturerName = propertyOf(manufacturerCodes)
-module.exports.getIndustryCode = propertyOf(industryNames)
-module.exports.getManufacturerCode = propertyOf(manufacturerNames)
-module.exports.getDeviceClassCode = propertyOf(deviceClassNames)
-module.exports.getDeviceClassName = propertyOf(deviceClassCodes)
-module.exports.defaultTransmitPGNs = defaultTransmitPGNs

package/lib/codes.test.js

@@ -1,17 +0,0 @@
-const { getManufacturerCode, getManufacturerName } = require('./codes')
-
-describe('getManufacturerCode', () => {
-  test('Return mfg number from name string', () => {
-    expect(getManufacturerCode('Furuno')).toBe(1855)
-    expect(getManufacturerCode('Yacht Devices')).toBe(717)
-    expect(getManufacturerCode('TJC Micro')).toBe(963)
-  })
-})
-
-describe('getManufacturerName', () => {
-  test('Return name string from mfg number', () => {
-    expect(getManufacturerName(1855)).toBe('Furuno')
-    expect(getManufacturerName(717)).toBe('Yacht Devices')
-    expect(getManufacturerName(963)).toBe('TJC Micro')
-  })
-})

package/lib/codesMfgs.json

@@ -1,166 +0,0 @@
-{
-  "AEM Power": 735,
-  "Actia": 199,
-  "Actisense - Active Research Ltd": 273,
-  "Advansea": 578,
-  "Aetna Engineering/Fireboy/Xintex": 215,
-  "Airmar": 135,
-  "Alltek Marine Electronics Corp": 459,
-  "Amphenol LTW Technology": 274,
-  "Aquatic AV": 600,
-  "Arlt Tecnologies": 614,
-  "Attwood Marine": 502,
-  "Au Electronics Group": 735,
-  "Autonnic": 715,
-  "Aventics GmbH": 605,
-  "B&G": 381,
-  "BEP Marine": 295,
-  "Bavaria Yacts": 637,
-  "Beede Instruments": 185,
-  "Beyond Measure": 396,
-  "Blue Water Data": 148,
-  "Blue Water Desalination": 811,
-  "Broyda Industries": 795,
-  "Böning Automationstechnologie GmbH & Co. KG": 341,
-  "CPAC Systems AB": 165,
-  "Camano Light": 384,
-  "Canadian Automotive": 796,
-  "Capi 2": 394,
-  "Carling Technologies Inc. (Moritz Aerospace)": 176,
-  "Chetco Digitial Instruments": 481,
-  "Clarion US": 773,
-  "Coelmo SRL Italy": 286,
-  "ComNav": 404,
-  "Comar Systems Limited": 438,
-  "Cummins": 440,
-  "DNA Group": 211,
-  "DaeMyung": 743,
-  "Dief": 329,
-  "Digital Switching Systems": 211,
-  "Digital Yacht": 437,
-  "DisenosY Technolgia": 201,
-  "Diverse Yacht Services": 641,
-  "EMMI NETWORK S.L.": 224,
-  "Egersund Marine Electronics AS": 426,
-  "Electronic Design": 373,
-  "Empir Bus": 304,
-  "Eride": 243,
-  "Evinrude/BRP": 163,
-  "FLIR": 815,
-  "FW Murphy/Enovation Controls": 78,
-  "Faria Instruments": 1863,
-  "Fell Marine": 844,
-  "Fischer Panda DE": 785,
-  "Fischer Panda Generators": 356,
-  "Floscan Instrument Co. Inc.": 192,
-  "Furuno": 1855,
-  "Fusion Electronics": 419,
-  "GME aka Standard Communications Pty LTD": 475,
-  "Garmin": 229,
-  "GeoNav": 385,
-  "Gill Sensors": 803,
-  "Glendinning": 378,
-  "Groco": 272,
-  "HMI Systems": 776,
-  "Hamilton Jet": 283,
-  "Hemisphere GPS Inc": 88,
-  "Honda Motor Company LTD": 257,
-  "Humminbird Marine Electronics": 467,
-  "ICOM": 315,
-  "Intellian": 606,
-  "JL Audio": 740,
-  "Japan Radio Co": 1853,
-  "Johnson Outdoors Marine Electronics Inc    Geonav": 385,
-  "KUS Manufacturer": 644,
-  "KVH": 579,
-  "Kohler Power Systems": 85,
-  "Korean Maritime University": 345,
-  "Kvasar AB": 1859,
-  "Lcj Capteurs": 499,
-  "Litton": 1858,
-  "Livorsi Marine": 400,
-  "Lowarnce": 140,
-  "Lowrance": 140,
-  "Lumishore": 798,
-  "LxNav": 739,
-  "MBW Technologies (formerly MAS)": 307,
-  "MMP": 1860,
-  "Maretron": 137,
-  "Marinecraft (South Korea)": 571,
-  "Marinesoft Co. LTD": 510,
-  "Mastervolt": 355,
-  "McMurdo Group aka Orolia LTD": 573,
-  "Mercury Marine": 144,
-  "Moritz Aerospace": 176,
-  "Mystic Valley Communications": 198,
-  "National Instruments Korea": 529,
-  "Nautibus Electronic GmbH": 147,
-  "Navico": 275,
-  "Navionics": 1852,
-  "Naviop S.R.L.": 503,
-  "NoLand Engineering": 517,
-  "Nobletec": 193,
-  "Northstar Technologies": 1854,
-  "Nothern Lights": 374,
-  "NovAtel": 305,
-  "Ocean Sat BV": 478,
-  "Ocean Signal": 777,
-  "Oceanvolt": 847,
-  "Offshore Systems (UK) Ltd.": 161,
-  "Onwa Marine": 532,
-  "Parker Hannnifin aka Village Marine Tech": 451,
-  "Poly Planar": 781,
-  "Prospec": 862,
-  "Qwerty": 328,
-  "REAP Systems": 734,
-  "Raymarine": 1851,
-  "Rockford Corp": 688,
-  "Rolls Royce Marine": 370,
-  "Rose Point Navigation Systems": 384,
-  "SAN GIORGIO S.E.I.N": 460,
-  "SI-TEX Marine Electronics": 470,
-  "Sailormade Marine Telmetry/Tetra Technology LTD": 235,
-  "SamwonIT": 612,
-  "San Jose Technology": 580,
-  "Sea Cross Marine AB": 471,
-  "Sea Recovery": 285,
-  "Seekeeper": 778,
-  "Shenzhen Jiuzhou Himunication": 658,
-  "Ship Module aka Customware": 595,
-  "Simrad": 1857,
-  "Sleipner Motor AS": 306,
-  "Standard Horizon": 421,
-  "Still Water Designs and Audto": 799,
-  "Suzuki Motor Corporation": 586,
-  "TeamSurv": 838,
-  "Teleflex Marine (SeaStar Solutions)": 1850,
-  "Thrane and Thrane": 351,
-  "Tides Marine": 797,
-  "TJC Micro": 963,
-  "Tohatsu Co, JP": 431,
-  "Transas USA": 518,
-  "Trimble": 1856,
-  "True Heading AB": 422,
-  "Twin Disc": 80,
-  "US Coast Guard": 591,
-  "Undheim Systems": 824,
-  "VDO (aka Continental-Corporation)": 443,
-  "Vector Cantech": 1861,
-  "Veethree Electronics & Marine": 466,
-  "Vesper Marine Ltd": 504,
-  "Victron Energy": 358,
-  "Volvo Penta": 174,
-  "Watcheye": 493,
-  "Wema U.S.A dba KUS": 644,
-  "Westerbeke": 154,
-  "Woosung": 744,
-  "Xantrex Technology Inc.": 168,
-  "Xintex/Atena": 215,
-  "Yacht Control": 583,
-  "Yacht Devices": 717,
-  "Yacht Monitoring Solutions": 233,
-  "Yamaha Marine": 1862,
-  "Yanmar Marine": 172,
-  "ZF Marine Electronics": 228,
-  "em-trak Marine Electronics": 427
-}