@canboat/canboatjs 3.3.3 → 3.3.4

package/lib/simpleCan.ts

@@ -1,140 +0,0 @@
-/**
- * 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,288 +0,0 @@
-const {
-  encodeActisense,
-  encodeYDRAW,
-  parseActisense,
-  parseCandump1,
-  parseCandump2,
-  parsePCDIN,
-  parsePDGY,
-  parseN2kString,
-  parsePDGYdebug,
-  parseYDRAW,
-  parseYDRAWOut,
-  encodeActisenseN2KACSII,
-  parseActisenseN2KASCII,
-  parseCandump3
-} = require('./stringMsg')
-
-/* globals describe test expect */
-
-describe('parseCandump1', () => {
-  test('basic messages', () => {
-    const msg = '<0x18eeff01> [8] 05 a0 be 1c 00 a0 a0 c0 '
-    expect(parseCandump1(msg)).toEqual({
-      canId: 0x18eeff01,
-      data: Buffer.from('05a0be1c00a0a0c0', 'hex'),
-      dst: 255,
-      format: 'candump1',
-      len: 8,
-      src: 1,
-      pgn: 60928,
-      prio: 6
-    })
-    const msg2 = '<0x18ea2301> [3] 14 f0 01 '
-    expect(parseCandump1(msg2)).toEqual({
-      canId: 0x18ea2301,
-      data: Buffer.from('14f001', 'hex'),
-      dst: 35,
-      format: 'candump1',
-      len: 3,
-      src: 1,
-      pgn: 59904,
-      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'
-    ]
-
-    let res
-    msgs.forEach((msg) => {
-      res = parseCandump2(msg)
-    })
-    expect(res).toEqual({
-      bus: 'can0',
-      canId: 234358051,
-      data: Buffer.from('c6ff00ffffffffff', 'hex'),
-      dst: 255,
-      format: 'candump2',
-      len: 8,
-      src: 35,
-      pgn: 129029,
-      prio: 3
-    })
-  })
-})
-
-describe('parseMultiLineCandumpV3', () => {
-  test('multi line messages', () => {
-    const msgs = [
-      '(0000000000.352000) vcan0 09F20101#601A00B706670D0B',
-      '(0000000000.353000) vcan0 09F20101#6186BA042600105F',
-      '(0000000000.354000) vcan0 09F20101#62090000008F027F',
-      '(0000000000.355000) vcan0 09F20101#63000000007F7FFF'
-    ]
-    let res
-    msgs.forEach((msg) => {
-      res = parseCandump3(msg)
-    })
-    expect(res).toEqual({
-      bus: 'vcan0',
-      canId: 166854913,
-      data: Buffer.from('63000000007f7fff', 'hex'),
-      dst: 255,
-      format: 'candump3',
-      src: 1,
-      pgn: 127489,
-      prio: 2,
-      timestamp: '(0000000000.355000)'
-    })
-  })
-})
-
-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'
-    expect(parseActisense(msg)).toEqual({
-      data: Buffer.from('00ff7f520021feff', 'hex'),
-      dst: 255,
-      len: 8,
-      format: 'Actisense',
-      pgn: 127257,
-      prio: 3,
-      src: 17,
-      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 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'
-describe('parsePDGY', () => {
-  test('basic msg', () => {
-    const msg = '!PDGY,126992,3,2,255,0.563,d2009e45b3b8821d'
-    expect(parsePDGY(msg)).toEqual({
-      data: Buffer.from('d2009e45b3b8821d', 'base64'),
-      dst: 255,
-      format: 'PDGY',
-      prefix: '!PDGY',
-      pgn: 126992,
-      prio: 3,
-      src: 2,
-      timer: 0.563,
-      coalesced: true
-    })
-  })
-  test('long msg', () => {
-    expect(parsePDGY(pdgyLong)).toEqual({
-      data: Buffer.from(
-        'UZ9FfR+bI/////////9//////////3//////////fwD8AIgTiBMAAAAAAQAAAAA',
-        'base64'
-      ),
-      dst: 255,
-      format: 'PDGY',
-      prefix: '!PDGY',
-      pgn: 129029,
-      prio: 3,
-      src: 2,
-      timer: 483.236,
-      coalesced: true
-    })
-  })
-})
-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]),
-      dst: 1,
-      format: 'PDGYdebug',
-      prefix: '$PDGY',
-      pgn: 0,
-      prio: 3,
-      src: 1,
-      fields: {
-        busLoad: 4,
-        deviceCount: 5,
-        errors: 0,
-        gatewaySrc: 1,
-        rejectedTX: 0,
-        timer: 482
-      }
-    })
-  })
-})
-
-describe('parsePCDIN', () => {
-  test('basic msg', () => {
-    const msg = '$PCDIN,01F119,00000000,0F,2AAF00D1067414FF*59'
-    expect(parsePCDIN(msg)).toEqual({
-      coalesced: true,
-      data: Buffer.from('2AAF00D1067414FF', 'hex'),
-      dst: 255,
-      format: 'PCDIN',
-      prefix: '$PCDIN',
-      pgn: 127257,
-      prio: 0,
-      src: 15,
-      timer: 1262304000000,
-      timestamp: new Date('2010-01-01T00:00:00.000Z')
-    })
-  })
-})
-
-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,
-      data: Buffer.from('50C3B81347D82BC6', 'hex'),
-      direction: 'R',
-      dst: 255,
-      format: 'YDRAW',
-      pgn: 129025,
-      prio: 2,
-      src: 127,
-      time: '16:29:27.082'
-    })
-  })
-})
-describe('parseYDRAWOut', () => {
-  test('basic msg', () => {
-    const msg = '0DF20E00 00 FD FF FF FF FF FF FF'
-    expect(parseYDRAWOut(msg)).toEqual({
-      canId: 0x0df20e00,
-      data: Buffer.from('00FDFFFFFFFFFFFF', 'hex'),
-      dst: 255,
-      format: 'YDRAW',
-      pgn: 127502,
-      prio: 3,
-      src: 0
-    })
-  })
-})
-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'
-    ])
-  })
-})
-
-describe('parseActisenseN2KASCII', () => {
-  test('basic msg', () => {
-    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'
-    })
-  })
-})
-describe('encodeActisenseN2KACSII', () => {
-  test('basic msg', () => {
-    const msg = 'A000000.000 05FF2 1F802 FFFC289A1600FFFF'
-    const n2k = parseActisenseN2KASCII(msg)
-    const res = encodeActisenseN2KACSII(n2k)
-    expect(res).toEqual(msg)
-  })
-})
-
-describe('parseN2kString', () => {
-  test('empty string or not string', () => {
-    const emptyMsg = 'Input not string or empty.'
-    expect(parseN2kString('').error.message).toBe(emptyMsg)
-    expect(parseN2kString('').input).toBe('')
-    expect(parseN2kString(5).error.message).toBe(emptyMsg)
-    expect(parseN2kString(5).input).toBe(5)
-  })
-  test('parser not found', () => {
-    const errMsg = {
-      error: new Error('Parser not found for input. - foo,bar'),
-      input: 'foo,bar',
-      format: 'MISSING_PARSER'
-    }
-    expect(parseN2kString('foo,bar')).toEqual(errMsg)
-  })
-})