@canboat/canboatjs 3.3.2 → 3.3.4

package/lib/bin/actisense-n2k-tcp.ts

@@ -1,50 +0,0 @@
-#!/usr/bin/env node
-
-import { createDebug } from '../utilities'
-import net from 'net'
-import { readN2KActisense } from '../n2k-actisense'
-import minimist from 'minimist'
-
-const debug = createDebug('canboatjs:w2k01')
-
-const argv = minimist(process.argv.slice(2), {
-  alias: { h: 'help' }
-})
-
-function help() {
-  console.error(`Usage: ${process.argv[0]} [options] host port
-
-Options:
-  -h, --help       output usage information`)
-  process.exit(1)
-}
-
-if (argv['help']) {
-  help()
-}
-
-if (argv['_'].length < 2) {
-  console.error('Please specify a host and port')
-  help()
-}
-
-const client = new net.Socket()
-client.connect(Number(argv['_'][1]), argv['_'][0], function () {
-  debug('Connected')
-})
-
-const context = {}
-client.on('data', function (data) {
-  readN2KActisense(data, true, context, (result) => {
-    console.log(result)
-  })
-})
-
-client.on('close', function () {
-  debug('Connection closed')
-})
-
-process.on('SIGINT', () => {
-  debug('SIGINT signal received.')
-  client.destroy()
-})

package/lib/bin/actisense-serialjs.ts

@@ -1,55 +0,0 @@
-#!/usr/bin/env node
-
-import { EventEmitter } from 'node:events'
-import minimist from 'minimist'
-import readline from 'readline'
-import { serial } from '../index'
-import { Transform } from 'stream'
-
-const argv = minimist(process.argv.slice(2), {
-  boolean: ['disable-output'],
-  alias: { h: 'help' }
-})
-
-if (argv['help']) {
-  console.error(`Usage: ${process.argv[0]} [options] device_path
-
-Options:
-  --disable-output don't output pgns
-  -h, --help       output usage information`)
-  process.exit(1)
-}
-
-if (argv['_'].length === 0) {
-  console.error('Please specify a device')
-  process.exit(1)
-}
-
-const app = new EventEmitter()
-
-const actisense = new (serial as any)({
-  app: app,
-  device: argv['_'][0],
-  plainText: true,
-  disableSetTransmitPGNs: true,
-  outputOnly: argv['disable-output']
-})
-const toStringTr = new Transform({
-  objectMode: true,
-
-  transform(chunk: any, encoding: string, callback: any) {
-    this.push(chunk + '\n')
-    callback()
-  }
-})
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  terminal: false
-})
-
-rl.on('line', (line) => {
-  app.emit('nmea2000out', line)
-})
-
-actisense.pipe(toStringTr).pipe(process.stdout)

package/lib/bin/analyzerjs.ts

@@ -1,66 +0,0 @@
-#!/usr/bin/env node
-
-import { PGN } from '@canboat/ts-pgns'
-import { Parser } from '../fromPgn'
-import minimist from 'minimist'
-import readline from 'readline'
-
-const argv = minimist(process.argv.slice(2), {
-  alias: { h: 'help' },
-  boolean: ['n', 'r', 'camel', 'camel-compat', 'show-non-matches']
-})
-
-if (argv['help']) {
-  console.error(`Usage: ${process.argv[1]} [options]
-
-Options:
-  -c                  don't check for invalid values
-  -n                  output null values
-  -r                  parse $MXPGN as little endian
-  --camel             output field names in camelCase
-  --camel-compat      output field names in camelCase and regular
-  --show-non-matches  show pgn data without any matches
-  -h, --help          output usage information`)
-  process.exit(1)
-}
-
-const parser = new Parser({
-  returnNulls: argv['n'] === true,
-  littleEndianMXPGN: argv['r'] === true,
-  checkForInvalidFields: argv['c'] !== true,
-  useCamel: argv['camel'],
-  useCamelCompat: argv['camel-compat'],
-  returnNonMatches: argv['show-non-matches']
-})
-
-parser.on('error', (pgn: PGN, error: any) => {
-  console.error(`Error parsing ${pgn.pgn} ${error}`)
-  console.error(error.stack)
-})
-
-parser.on('warning', (_pgn: PGN, _error: any) => {
-  //console.error(`Warning parsing ${pgn.pgn} ${error}`)
-})
-
-parser.on('pgn', (pgn: PGN) => {
-  console.log(JSON.stringify(pgn))
-})
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-  terminal: false
-})
-
-rl.on('line', (line: string) => {
-  if (argv['log-input']) {
-    console.log(line)
-  }
-  if (line.length > 13 && line.charAt(13) === ';') {
-    if (line.charAt(14) === 'A') {
-      parser.parseString(line.substring(16))
-    }
-  } else {
-    parser.parseString(line.trim())
-  }
-})

package/lib/bin/candumpjs.ts

@@ -1,100 +0,0 @@
-#!/usr/bin/env node
-
-import { FromPgn } from '../index'
-import { parseCanId } from '../canId'
-import minimist from 'minimist'
-import { binToActisense } from '../utilities'
-
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const socketcan = require('socketcan')
-
-const argv = minimist(process.argv.slice(2), {
-  alias: {
-    h: 'help',
-    boolean: ['n', 'r', 'camel', 'camel-compat', 'show-non-matches']
-  }
-})
-
-if (argv['help']) {
-  console.error(`Usage: ${process.argv[0]} [options] candevice
-
-Options:
-  --format <format>   json, actisense
-  -c                  don't check for invalid values
-  -n                  output null values
-  -r                  parse $MXPGN as little endian
-  --camel             output field names in camelCase
-  --camel-compat      output field names in camelCase and regular
-  --show-non-matches  show pgn data without any matches
-  -h, --help          output usage information`)
-  process.exit(1)
-}
-
-if (argv['_'].length === 0) {
-  console.error('Please specify a device')
-  process.exit(1)
-}
-
-const parser = new FromPgn({
-  returnNulls: argv['n'] === true,
-  littleEndianMXPGN: argv['r'] === true,
-  checkForInvalidFields: argv['c'] !== true,
-  useCamel: argv['camel'],
-  useCamelCompat: argv['camel-compat'],
-  returnNonMatches: argv['show-non-matches']
-})
-
-const format = argv['format'] || 'json'
-
-/*
-
-let messageCb = (data) => {
-  let jsonData = parser.parse(data, (err) => { if ( err ) console.error(err) })
-  if ( jsonData ) {
-    console.log(data)
-  }
-}
-
-let simpleCan = new canboatjs.SimpleCan({
-  canDevice: argv['_'][0],
-  preferredAddress: 35,
-  disableDefaultTransmitPGNs: true,
-  transmitPGNs: [],
-}, messageCb)
-
-simpleCan.start()
-
-*/
-
-parser.on('error', (pgn, error) => {
-  console.error(`Error parsing ${pgn.pgn} ${error}`)
-  console.error(error.stack)
-})
-
-parser.on('pgn', (pgn) => {
-  console.log(JSON.stringify(pgn))
-})
-
-const canDevice = argv['_'][0]
-
-const channel = socketcan.createRawChannel(canDevice)
-
-channel.addListener('onStopped', (msg: any) => {
-  console.error(`socketcan stopped ${msg}`)
-})
-
-channel.addListener('onMessage', (msg: any) => {
-  const pgn = parseCanId(msg.id)
-
-  const timestamp = new Date().toISOString()
-
-  const sourceString = binToActisense(pgn, timestamp, msg.data, msg.data.length)
-
-  if (format === 'json') {
-    parser.parse({ pgn, length: msg.data.length, data: msg.data, sourceString })
-  } else {
-    console.log(sourceString)
-  }
-})
-
-channel.start()

package/lib/bin/cansend.ts

@@ -1,131 +0,0 @@
-#!/usr/bin/env node
-
-import { parseActisense } from '../stringMsg'
-import { toPgn } from '../toPgn'
-import { getPlainPGNs, binToActisense } from '../utilities'
-import { encodeCanId } from '../canId'
-import readline from 'readline'
-import minimist from 'minimist'
-
-const argv = 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: any
-
-if (!test) {
-  // eslint-disable-next-line @typescript-eslint/no-require-imports
-  const socketcan = require('socketcan')
-  channel = socketcan.createRawChannel(canDevice)
-
-  channel.addListener('onStopped', (msg: any) => {
-    console.error(`socketcan stopped ${msg}`)
-  })
-
-  channel.start()
-}
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-  terminal: false
-})
-
-rl.on('line', function (line) {
-  if (line.length === 0) {
-    return
-  }
-
-  let msg = line[0] === '{' ? JSON.parse(line) : line
-
-  if (typeof msg === 'string') {
-    const 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
-    }
-  }
-
-  let pgn: any, canid: number, buffer: Buffer | undefined
-  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
-  }
-
-  const timestamp = new Date().toISOString()
-
-  if (buffer == undefined) {
-    console.error('unable to encode: %s', line)
-    return
-  } else {
-    if (buffer.length > 8 || pgn.pgn == 126720) {
-      const pgns = getPlainPGNs(buffer)
-      pgns.forEach((pbuffer) => {
-        if (!test) {
-          channel.send({ id: canid, ext: true, data: pbuffer })
-        }
-        if (logOut) {
-          console.log(binToActisense(pgn, timestamp, pbuffer, pbuffer.length))
-        }
-      })
-    } else {
-      if (!test) {
-        channel.send({ id: canid, ext: true, data: buffer })
-      }
-      if (logOut) {
-        console.log(binToActisense(pgn, timestamp, buffer, buffer.length))
-      }
-    }
-  }
-})

package/lib/bin/ikonvert-serial.ts

@@ -1,44 +0,0 @@
-#!/usr/bin/env node
-
-import { Transform } from 'stream'
-// eslint-disable-next-line @typescript-eslint/no-require-imports
-const { SerialPort } = require('serialport')
-
-if (process.argv.length < 3) {
-  console.error('Please specify a device')
-  console.error('usage: ikonvert-serial [device] [baud,default:230400]')
-  process.exit(1)
-}
-
-const device = process.argv[2]
-
-const baud = process.argv.length > 3 ? Number(process.argv[3]) : 230400
-
-const serial = new SerialPort({
-  path: device,
-  baudRate: baud
-})
-
-const toStringTr = new Transform({
-  objectMode: true,
-
-  transform(line, encoding, callback) {
-    //this.push(JSON.stringify(chunk) + "\n");
-    console.log(line)
-
-    if (line.startsWith('$PDGY,000000,,,,,')) {
-      serial.write('$PDGY,N2NET_INIT,ALL\r\n')
-    }
-
-    callback()
-  }
-})
-
-serial.on('open', function () {
-  const parser = new SerialPort.parsers.Readline()
-  serial.pipe(parser).pipe(toStringTr)
-})
-
-serial.on('error', (x: any) => {
-  console.log(x)
-})

package/lib/bin/to-pgn.ts

@@ -1,65 +0,0 @@
-#!/usr/bin/env node
-
-import minimist from 'minimist'
-import readline from 'readline'
-import {
-  pgnToActisenseSerialFormat,
-  pgnToActisenseN2KAsciiFormat,
-  pgnToiKonvertSerialFormat,
-  pgnToYdgwRawFormat,
-  pgnToYdgwFullRawFormat,
-  pgnToPCDIN,
-  pgnToMXPGN
-} from '../index'
-
-const argv = minimist(process.argv.slice(2), {
-  string: ['format'],
-  alias: { h: 'help' }
-})
-
-if (argv['help']) {
-  console.error(`Usage: ${process.argv[0]} [options]
-
-Options:
-  --format <format>   actisense, actisensen2kascii, ikconvert, ydgw, yd-full, pcdin, mxpgn
-  -h, --help          output usage information`)
-  process.exit(1)
-}
-
-const formatters: { [key: string]: any } = {
-  actisense: pgnToActisenseSerialFormat,
-  n2kascii: pgnToActisenseN2KAsciiFormat,
-  ikconvert: pgnToiKonvertSerialFormat,
-  ydgw: pgnToYdgwRawFormat,
-  pcdin: pgnToPCDIN,
-  mxpgn: pgnToMXPGN,
-  'yd-full': pgnToYdgwFullRawFormat
-}
-
-const format = argv['format'] || 'actisense'
-const formatter = formatters[format]
-if (!formatter) {
-  console.error(`unknown format: ${argv['format']}`)
-  process.exit(1)
-}
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-  terminal: false
-})
-
-rl.on('line', function (line) {
-  const msg = JSON.parse(line)
-  const res = formatter(msg)
-  if (Array.isArray(res)) {
-    res.forEach((m) => {
-      console.log(m)
-    })
-  } else {
-    console.log(res)
-  }
-  //console.log(pgnToActisenseSerialFormat(msg))
-  //console.log(pgnToiKonvertSerialFormat(pgn))
-  //console.log(pgnToYdgwRawFormat(msg))
-})

package/lib/bin/ydvr-file

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-
-const YdvrStream = require('../lib/ydvr.js')
-
-const argv = require('minimist')(process.argv.slice(2), {
-  alias: { h: 'help' }
-})
-
-if (argv['help']) {
-  console.error(`Usage: ${process.argv[0]} file
-
-Options:
-  -h, --help       output usage information`)
-  process.exit(1)
-}
-
-if (argv['_'].length === 0) {
-  console.error('Please specify a file')
-  process.exit(1)
-}
-
-const serial = YdvrStream()
-
-filestream = require('fs').createReadStream(argv['_'][0])
-filestream.on('error', (err) => {
-  console.error(err.message)
-})
-filestream.on('end', () => {
-  process.exit(0)
-})
-filestream.pipe(serial).on('data', (chunk) => {
-  console.log(JSON.stringify(chunk))
-})

package/lib/canId.test.js

@@ -1,61 +0,0 @@
-const { encodeCanId, parseCanId, parseEncode } = require('./canId')
-
-/* globals describe test expect */
-
-describe('parseCanId', () => {
-  test('Return object with canId broken into properties', () => {
-    expect(parseCanId(0x18eeff01)).toEqual({
-      canId: 0x18eeff01,
-      dst: 255,
-      src: 1,
-      pgn: 60928,
-      prio: 6
-    })
-    expect(parseCanId(0xcf004ee)).toEqual({
-      canId: 0xcf004ee,
-      dst: 255,
-      src: 0xee,
-      pgn: 0xf004,
-      prio: 0xc >> 2
-    })
-    expect(parseCanId(0x18ea2301)).toEqual({
-      canId: 0x18ea2301,
-      dst: 35,
-      src: 0x01,
-      pgn: 0xea00,
-      prio: 6
-    })
-    expect(parseCanId(0x09f8017f)).toEqual({
-      canId: 0x09f8017f,
-      dst: 255,
-      src: 127,
-      pgn: 129025,
-      prio: 2
-    })
-    expect(parseCanId(0x0df8057f)).toEqual({
-      canId: 0x0df8057f,
-      dst: 255,
-      src: 127,
-      pgn: 129029,
-      prio: 3
-    })
-  })
-})
-describe('encodeCanId', () => {
-  test('Return canId number from object', () => {
-    expect(
-      encodeCanId({ src: 1, pgn: 60928, prio: 6, dst: 255 }).toString(2)
-    ).toBe((0x18eeff01).toString(2))
-    expect(encodeCanId({ src: 238, pgn: 61444, prio: 3 })).toBe(0xcf004ee)
-  })
-})
-
-describe('parseEncode', () => {
-  test('Return exactly same number after parse and encode', () => {
-    expect(parseEncode(0x18eeff01)).toBe(0x18eeff01)
-    expect(parseEncode(0xcf004ee)).toBe(0xcf004ee)
-    expect(parseEncode(0x18ea2301)).toBe(0x18ea2301)
-    expect(parseEncode(0x09f8017f)).toBe(0x09f8017f)
-    expect(parseEncode(0x0df8057f)).toBe(0x0df8057f)
-  })
-})

package/lib/canId.ts

@@ -1,84 +0,0 @@
-import { flow } from 'lodash/fp'
-
-export type ParsedCanID = {
-  canId: number
-  prio: number
-  src: number
-  pgn: number
-  dst: number
-}
-
-export type CanID = {
-  prio: number
-  src: number
-  pgn: number
-  dst: number
-}
-
-// Decode CAN Identifier (canId). ISO 11783 (CAN 2.0 B Extended Frame Format)
-export const parseCanId = (id: number): ParsedCanID => {
-  const PF = (id >> 16) & 0xff // PDU Format
-  const PS = (id >> 8) & 0xff // PDU Specific
-  const DP = (id >> 24) & 1 // Data Page
-
-  let dst: number, pgn: number
-
-  if (PF < 240) {
-    /* PDU1 format, the PS contains the destination address */
-    dst = PS
-    pgn = (DP << 16) + (PF << 8)
-  } else {
-    /* PDU2 format, the destination is implied global and the PGN is extended */
-    dst = 0xff
-    pgn = (DP << 16) + (PF << 8) + PS
-  }
-  return {
-    canId: id, // Include original canId in return object.
-    prio: (id >> 26) & 0x7, // Priority
-    src: id & 0xff, // Source Address (SA),
-    pgn,
-    dst
-  }
-}
-// canId should be a hex encoded string without spaces or commas.
-export const parseCanIdStr = (canId: string) => parseCanId(parseInt(canId, 16))
-
-export const buildCanId = (
-  prio: string | number,
-  pgn: string | number,
-  dst: string | number,
-  src: string | number
-): CanID => ({
-  prio: Number(prio),
-  pgn: Number(pgn),
-  dst: Number(dst),
-  src: Number(src)
-})
-
-// Encode CAN Identifier (canId)
-export const encodeCanId = (id: CanID) => {
-  let canId = id.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 = (id.pgn >> 8) & 0xff
-
-  if (PF < 240) {
-    // PDU 1
-    canId = canId | ((id.dst & 0xff) << 8)
-    canId = canId | (id.pgn << 8)
-  } else {
-    // PDU 2
-    canId = canId | (id.pgn << 8)
-  }
-  canId = canId | (id.prio << 26)
-
-  return canId
-}
-export const canIdString = (canId: number) =>
-  canId.toString(16).padStart(8, '0')
-export const encodeCanIdString = flow(encodeCanId, canIdString)
-// Utility function that parses and re-encodes. Compare result to original.
-export const parseEncode = (x: number) => encodeCanId(parseCanId(x))