@canboat/canboatjs 3.0.2 → 3.2.2

package/lib/simpleCan.ts

@@ -0,0 +1,140 @@
+/**
+ * Copyright 2025 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.
+ */
+
+import { CanDevice } from './candevice'
+import { CanID, encodeCanId, parseCanId } from './canId'
+import { toActisenseSerialFormat, parseActisense } from './stringMsg'
+import { toPgn } from './toPgn'
+import { getPlainPGNs, binToActisense, createDebug } from './utilities'
+import _ from 'lodash'
+
+const debug = createDebug('canboatjs:simpleCan')
+
+export function SimpleCan(
+  this: any,
+  options: any,
+  messageCb: (data: any) => void
+) {
+  this.options = options
+  this.messageCb = messageCb
+  this.plainText = false
+  // eslint-disable-next-line @typescript-eslint/no-require-imports
+  this.socketcan = require('socketcan')
+}
+
+SimpleCan.prototype.start = function () {
+  const canDevice = this.options.canDevice || 'can0'
+
+  this.channel = this.socketcan.createRawChannel(canDevice)
+  if (this.messageCb) {
+    this.channel.addListener('onMessage', (msg: any) => {
+      const pgn = parseCanId(msg.id)
+
+      if (
+        this.candevice &&
+        this.candevice.cansend &&
+        pgn.src == this.candevice.address
+      ) {
+        return
+      }
+
+      const timestamp = new Date().toISOString()
+      if (this.plainText) {
+        this.messageCb(
+          binToActisense(pgn, timestamp, msg.data, msg.data.length)
+        )
+      } else {
+        this.messageCb({ pgn, length: msg.data.length, data: msg.data })
+      }
+    })
+  }
+  this.channel.start()
+  this.candevice = new CanDevice(this, {
+    ...this.options,
+    disableDefaultTransmitPGNs: true,
+    disableNAKs: true
+  })
+  this.candevice.start()
+}
+
+SimpleCan.prototype.sendPGN = function (msg: any) {
+  if (this.candevice) {
+    if (
+      !this.candevice.cansend &&
+      msg.pgn !== 59904 &&
+      msg.pgn !== 60928 &&
+      msg.pgn !== 126996
+    ) {
+      debug('ignoring %j', msg)
+      return
+    }
+
+    debug('sending %j', msg)
+
+    const src =
+      msg.pgn === 59904 || (msg as any).forceSrc
+        ? msg.src
+        : this.candevice.address
+    if (_.isString(msg)) {
+      const 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
+      }
+    }
+
+    let canid: number
+    let buffer: Buffer | undefined
+
+    let pgn
+    if (_.isObject(msg)) {
+      canid = encodeCanId(msg as CanID)
+      buffer = toPgn(msg)
+      pgn = msg
+    } else {
+      pgn = parseActisense(msg)
+      canid = encodeCanId(pgn)
+      buffer = pgn.data
+    }
+
+    if (debug.enabled) {
+      const str = toActisenseSerialFormat(pgn.pgn, buffer, pgn.dst, pgn.src)
+      debug(str)
+    }
+
+    if (buffer) {
+      //seems as though 126720 should always be encoded this way
+      if (buffer.length > 8 || pgn.pgn == 126720) {
+        const 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 })
+      }
+    }
+  }
+}
+
+SimpleCan.prototype.sendActisenseFormat = function (msg: string) {
+  this.sendPGN(msg)
+}

package/lib/stringMsg.test.js

@@ -1,6 +1,17 @@
 const {
-  encodeActisense, encodeYDRAW, parseActisense, parseCandump1, parseCandump2,
-  parsePCDIN, parsePDGY, parseN2kString, parsePDGYdebug, parseYDRAW, encodeActisenseN2KACSII, parseActisenseN2KASCII, parseCandump3
+  encodeActisense,
+  encodeYDRAW,
+  parseActisense,
+  parseCandump1,
+  parseCandump2,
+  parsePCDIN,
+  parsePDGY,
+  parseN2kString,
+  parsePDGYdebug,
+  parseYDRAW,
+  encodeActisenseN2KACSII,
+  parseActisenseN2KASCII,
+  parseCandump3
 } = require('./stringMsg')
 
 /* globals describe test expect */
@@ -16,7 +27,7 @@ describe('parseCandump1', () => {
       len: 8,
       src: 1,
       pgn: 60928,
-      prio: 6,
+      prio: 6
     })
     const msg2 = '<0x18ea2301> [3] 14 f0 01 '
     expect(parseCandump1(msg2)).toEqual({
@@ -27,28 +38,29 @@ describe('parseCandump1', () => {
       len: 3,
       src: 1,
       pgn: 59904,
-      prio: 6,
+      prio: 6
     })
-
   })
 })
 
 describe('parseMultiLineCandump', () => {
   test('multi line messages', () => {
-    const msgs = ['can0  0DF80523   [8]  C0 2B 7E 9A 47 70 F8 2F',
-                  'can0  0DF80523   [8]  C1 26 00 0C D1 EF 45 98',
-                  'can0  0DF80523   [8]  C2 E5 05 00 7E C2 94 03',
-                  'can0  0DF80523   [8]  C3 A8 29 F6 C0 B6 77 02',
-                  'can0  0DF80523   [8]  C4 00 00 00 00 23 FC 0A',
-                  'can0  0DF80523   [8]  C5 5A 00 A0 00 EE F3 FF',
-                  'can0  0DF80523   [8]  C6 FF 00 FF FF FF FF FF']
+    const msgs = [
+      'can0  0DF80523   [8]  C0 2B 7E 9A 47 70 F8 2F',
+      'can0  0DF80523   [8]  C1 26 00 0C D1 EF 45 98',
+      'can0  0DF80523   [8]  C2 E5 05 00 7E C2 94 03',
+      'can0  0DF80523   [8]  C3 A8 29 F6 C0 B6 77 02',
+      'can0  0DF80523   [8]  C4 00 00 00 00 23 FC 0A',
+      'can0  0DF80523   [8]  C5 5A 00 A0 00 EE F3 FF',
+      'can0  0DF80523   [8]  C6 FF 00 FF FF FF FF FF'
+    ]
 
     let res
     msgs.forEach((msg) => {
       res = parseCandump2(msg)
     })
     expect(res).toEqual({
-      bus: "can0",
+      bus: 'can0',
       canId: 234358051,
       data: Buffer.from('c6ff00ffffffffff', 'hex'),
       dst: 255,
@@ -56,7 +68,7 @@ describe('parseMultiLineCandump', () => {
       len: 8,
       src: 35,
       pgn: 129029,
-      prio: 3,
+      prio: 3
     })
   })
 })
@@ -74,7 +86,7 @@ describe('parseMultiLineCandumpV3', () => {
       res = parseCandump3(msg)
     })
     expect(res).toEqual({
-      bus: "vcan0",
+      bus: 'vcan0',
       canId: 166854913,
       data: Buffer.from('63000000007f7fff', 'hex'),
       dst: 255,
@@ -89,7 +101,8 @@ describe('parseMultiLineCandumpV3', () => {
 
 describe('parseActisense', () => {
   test('basic msg', () => {
-    const msg = '2016-04-09T16:41:09.078Z,3,127257,17,255,8,00,ff,7f,52,00,21,fe,ff'
+    const msg =
+      '2016-04-09T16:41:09.078Z,3,127257,17,255,8,00,ff,7f,52,00,21,fe,ff'
     expect(parseActisense(msg)).toEqual({
       data: Buffer.from('00ff7f520021feff', 'hex'),
       dst: 255,
@@ -98,20 +111,22 @@ describe('parseActisense', () => {
       pgn: 127257,
       prio: 3,
       src: 17,
-      timestamp: '2016-04-09T16:41:09.078Z',
+      timestamp: '2016-04-09T16:41:09.078Z'
     })
   })
 })
 describe('encodeActisense', () => {
   test('basic msg', () => {
-    const msg = '2016-04-09T16:41:09.078Z,3,127257,17,255,8,00,ff,7f,52,00,21,fe,ff'
+    const msg =
+      '2016-04-09T16:41:09.078Z,3,127257,17,255,8,00,ff,7f,52,00,21,fe,ff'
     const n2k = parseActisense(msg)
     const res = encodeActisense(n2k)
     expect(res).toEqual(msg)
   })
 })
 
-const pdgyLong = '!PDGY,129029,3,2,255,483.236,UZ9FfR+bI/////////9//////////3//////////fwD8AIgTiBMAAAAAAQAAAAA'
+const pdgyLong =
+  '!PDGY,129029,3,2,255,483.236,UZ9FfR+bI/////////9//////////3//////////fwD8AIgTiBMAAAAAAQAAAAA'
 describe('parsePDGY', () => {
   test('basic msg', () => {
     const msg = '!PDGY,126992,3,2,255,0.563,d2009e45b3b8821d'
@@ -129,7 +144,10 @@ describe('parsePDGY', () => {
   })
   test('long msg', () => {
     expect(parsePDGY(pdgyLong)).toEqual({
-      data: Buffer.from('UZ9FfR+bI/////////9//////////3//////////fwD8AIgTiBMAAAAAAQAAAAA', 'base64'),
+      data: Buffer.from(
+        'UZ9FfR+bI/////////9//////////3//////////fwD8AIgTiBMAAAAAAQAAAAA',
+        'base64'
+      ),
       dst: 255,
       format: 'PDGY',
       prefix: '!PDGY',
@@ -145,7 +163,7 @@ describe('parsePDGYdebug', () => {
   test('basic msg', () => {
     const msg = '$PDGY,000000,4,,5,482,1,0'
     expect(parsePDGYdebug(msg)).toEqual({
-      data: Buffer.from([4,0,5,482,1,0]),
+      data: Buffer.from([4, 0, 5, 482, 1, 0]),
       dst: 1,
       format: 'PDGYdebug',
       prefix: '$PDGY',
@@ -158,7 +176,7 @@ describe('parsePDGYdebug', () => {
         errors: 0,
         gatewaySrc: 1,
         rejectedTX: 0,
-        timer: 482,
+        timer: 482
       }
     })
   })
@@ -177,7 +195,7 @@ describe('parsePCDIN', () => {
       prio: 0,
       src: 15,
       timer: 1262304000000,
-      timestamp: new Date("2010-01-01T00:00:00.000Z"),
+      timestamp: new Date('2010-01-01T00:00:00.000Z')
     })
   })
 })
@@ -186,7 +204,7 @@ describe('parseYDRAW', () => {
   test('basic msg', () => {
     const msg = '16:29:27.082 R 09F8017F 50 C3 B8 13 47 D8 2B C6'
     expect(parseYDRAW(msg)).toEqual({
-      canId: 0x09F8017F,
+      canId: 0x09f8017f,
       data: Buffer.from('50C3B81347D82BC6', 'hex'),
       direction: 'R',
       dst: 255,
@@ -194,20 +212,20 @@ describe('parseYDRAW', () => {
       pgn: 129025,
       prio: 2,
       src: 127,
-      time: '16:29:27.082',
+      time: '16:29:27.082'
     })
   })
 })
 describe('encodeYDRAW', () => {
   test('long msg', () => {
     expect(encodeYDRAW(parsePDGY(pdgyLong))).toEqual([
-      "0df80502 40 2f 51 9f 45 7d 1f 9b",
-      "0df80502 41 23 ff ff ff ff ff ff",
-      "0df80502 42 ff 7f ff ff ff ff ff",
-      "0df80502 43 ff ff 7f ff ff ff ff",
-      "0df80502 44 ff ff ff 7f 00 fc 00",
-      "0df80502 45 88 13 88 13 00 00 00",
-      "0df80502 46 00 01 00 00 00 00 ff",
+      '0df80502 40 2f 51 9f 45 7d 1f 9b',
+      '0df80502 41 23 ff ff ff ff ff ff',
+      '0df80502 42 ff 7f ff ff ff ff ff',
+      '0df80502 43 ff ff 7f ff ff ff ff',
+      '0df80502 44 ff ff ff 7f 00 fc 00',
+      '0df80502 45 88 13 88 13 00 00 00',
+      '0df80502 46 00 01 00 00 00 00 ff'
     ])
   })
 })
@@ -217,13 +235,13 @@ describe('parseActisenseN2KASCII', () => {
     const msg = 'A000021.293 05FF2 1F802 FFFC289A1600FFFF'
     expect(parseActisenseN2KASCII(msg)).toEqual({
       data: Buffer.from('FFFC289A1600FFFF', 'hex'),
-      "dst": 255,
-      "format": "Actisense N2K ASCII",
-      "len": 16,
-      "pgn": 129026,
-      "prio": 2,
-      "src": 5,
-      "time": "000021.293"
+      dst: 255,
+      format: 'Actisense N2K ASCII',
+      len: 16,
+      pgn: 129026,
+      prio: 2,
+      src: 5,
+      time: '000021.293'
     })
   })
 })
@@ -236,7 +254,6 @@ describe('encodeActisenseN2KACSII', () => {
   })
 })
 
-
 describe('parseN2kString', () => {
   test('empty string or not string', () => {
     const emptyMsg = 'Input not string or empty.'
@@ -249,7 +266,7 @@ describe('parseN2kString', () => {
     const errMsg = {
       error: new Error('Parser not found for input. - foo,bar'),
       input: 'foo,bar',
-      format: 'MISSING_PARSER',
+      format: 'MISSING_PARSER'
     }
     expect(parseN2kString('foo,bar')).toEqual(errMsg)
   })