@canboat/canboatjs 3.3.3 → 3.3.4

package/lib/utilities.ts

@@ -1,169 +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.
- */
-
-import { debug } from 'debug'
-import { CanID } from './canId'
-import { map, padCharsStart, trimChars } from 'lodash/fp'
-import fs from 'fs'
-
-const getDataPath = (options: any) => {
-  if (options.app?.config?.configPath !== undefined) {
-    return `${options.app.config.configPath}/canboatjs-data.json`
-  }
-}
-
-export const getPersistedData = (options: any, id: string, key: string) => {
-  const path = getDataPath(options)
-  if (path !== undefined) {
-    const content = fs.readFileSync(path)
-    const data = JSON.parse(content.toString())
-    return data[id] !== undefined && data[id][key]
-  }
-}
-
-export const savePersistedData = (
-  options: any,
-  id: string,
-  key: string,
-  value: any
-) => {
-  const path = getDataPath(options)
-  if (path !== undefined) {
-    let content: string
-
-    try {
-      content = fs.readFileSync(path).toString()
-    } catch (err: any) {
-      if (err.code === 'ENOENT') {
-        content = '{}'
-      } else {
-        throw err
-      }
-    }
-    const data = JSON.parse(content.toString())
-    if (data[id] === undefined) {
-      data[id] = {}
-    }
-    data[id][key] = value
-    fs.writeFileSync(path, JSON.stringify(data, null, 2))
-  }
-}
-
-export const createDebug = (name: string, appOptions: any = undefined) => {
-  if (appOptions !== undefined && appOptions.createDebug !== undefined) {
-    return appOptions.createDebug(name)
-  } else {
-    return debug(name)
-  }
-}
-
-export function getPlainPGNs(buffer: Buffer) {
-  const res = []
-  let bucket = 0x40 // 64
-
-  const first = Buffer.alloc(8)
-  first.writeUInt8(bucket++, 0)
-  first.writeUInt8(buffer.length, 1)
-  buffer.copy(first, 2, 0, 6)
-  res.push(first)
-
-  for (let index = 6; index < buffer.length; index += 7) {
-    const next = Buffer.alloc(8)
-    next.writeUInt8(bucket++, 0)
-    let end = index + 7
-    let fill = 0
-    if (end > buffer.length) {
-      fill = end - buffer.length
-      end = buffer.length
-    }
-    buffer.copy(next, 1, index, end)
-    if (fill > 0) {
-      for (let i = end - index + 1; i < 8; i++) {
-        next.writeUInt8(0xff, i)
-      }
-    }
-    res.push(next)
-  }
-  return res
-}
-
-const m_hex = [
-  '0',
-  '1',
-  '2',
-  '3',
-  '4',
-  '5',
-  '6',
-  '7',
-  '8',
-  '9',
-  'A',
-  'B',
-  'C',
-  'D',
-  'E',
-  'F'
-]
-
-function toHexString(v: number) {
-  const msn = (v >> 4) & 0x0f
-  const lsn = (v >> 0) & 0x0f
-  return m_hex[msn] + m_hex[lsn]
-}
-
-export function compute0183Checksum(sentence: string) {
-  // skip the $
-  let i = 1
-  // init to first character
-  let c1 = sentence.charCodeAt(i)
-  // process rest of characters, zero delimited
-  for (i = 2; i < sentence.length; ++i) {
-    c1 = c1 ^ sentence.charCodeAt(i)
-  }
-  return '*' + toHexString(c1)
-}
-
-export function binToActisense(
-  pgn: CanID,
-  timestamp: string,
-  data: Buffer,
-  length: number
-) {
-  const arr: string[] = []
-  return (
-    timestamp +
-    `,${pgn.prio},${pgn.pgn},${pgn.src},${pgn.dst},${length},` +
-    new Uint32Array(data)
-      .reduce(function (acc, i) {
-        acc.push(i.toString(16))
-        return acc
-      }, arr)
-      .map((x) => (x.length === 1 ? '0' + x : x))
-      .join(',')
-  )
-}
-
-export const trimWrap = trimChars('()<>[]')
-export const rmChecksum = (str: string) =>
-  str.includes('*') ? str.split('*', 1)[0] : str
-export const arrBuff = (arr: string[], encoding: BufferEncoding = 'hex') =>
-  Buffer.from(arr.join(''), encoding)
-export const hexByte = (x: number) =>
-  padCharsStart('0', 2, Number(x).toString(16))
-export const byteString = (data: Buffer, separator = ',') =>
-  // Uint32Array map method doesn't work as expect. _.map does.
-  map(exports.hexByte, new Uint32Array(data)).join(separator)

package/lib/venus-mqtt.js

@@ -1,118 +0,0 @@
-const Transform = require('stream').Transform
-const mqtt = require('mqtt')
-const debug = require('debug')('venus-mqtt')
-//const pgns = require('./fromPgn').pgns
-const _ = require('lodash')
-
-function MQTTStream(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-  this.options = options
-}
-
-require('util').inherits(MQTTStream, Transform)
-
-MQTTStream.prototype.discoveryAvailable = function () {
-  return moduleAvailable('md' + 'ns')
-}
-
-MQTTStream.prototype.pipe = function (pipeTo) {
-  const that = this
-  this.startDiscovery()
-    .then((service) => {
-      let url = service.txtRecord.mqtt_broker
-      var client = mqtt.connect(url)
-      client.on('connect', function () {
-        debug(`connected to ${url}`)
-
-        client.subscribe('n2k/mqtt_n2k/self')
-        //client.subscribe('n2k/mqtt_n2k/listenpgns')
-        client.publish('n2k/mqtt_n2k/getself')
-        client.publish('n2k/mqtt_n2k/addpgn', '129026')
-        client.publish('n2k/mqtt_n2k/addpgn', '129025')
-        //client.publish('n2k/mqtt_n2k/getlistenpgns')
-        client.subscribe('n2k/mqtt_n2k/bus/#')
-
-        /*
-      pgns.forEach(key => {
-        debug(`adding pgn ${key}`)
-        client.publish('n2k/mqtt_n2k/addpgn', key)
-        //require('sleep').msleep(100)
-      })
-      */
-      })
-
-      client.on('error', (error) => {
-        this.options.app.setProviderError(`error connecting to mqtt ${error}`)
-      })
-
-      client.on('close', () => {
-        this.options.app.setProviderError(`mqtt close`)
-      })
-
-      client.on('reconnect', () => {
-        //this.(`mqtt reconnect`)
-      })
-
-      client.on('message', (topic, json) => {
-        debug(`${topic}: '${json}'`)
-        const pgn = JSON.parse(json)
-        if (topic.startsWith('n2k/mqtt_n2k/bus/')) {
-          that.push(pgn)
-        }
-      })
-    })
-    .catch((error) => {
-      debug(error)
-      this.options.app.setProviderStatus(error.msg)
-    })
-
-  Transform.prototype.pipe.call(this, pipeTo)
-}
-
-MQTTStream.prototype.startDiscovery = function () {
-  var that = this
-  return new Promise(function (resolve, reject) {
-    if (!that.discoveryAvailable()) {
-      console.log('Discovery requires mdns or specify hostname and port')
-      reject('Discovery requires mdns')
-    }
-
-    var mdns = require('md' + 'ns')
-
-    function doStart(serviceName) {
-      let browser = mdns.createBrowser(mdns.tcp(serviceName), {
-        resolverSequence: [mdns.rst.DNSServiceResolve()]
-      })
-      browser.on('serviceUp', function (service) {
-        debug(`Discovered ${serviceName}:` + JSON.stringify(service, null, 2))
-        //that.get('/signalk', service.host, service.port, isHttps ? 'https' : 'http').then(function(response) {
-        debug(
-          `Service at ${service.host}:${service.port} ${service.txtRecord.base_topic}`
-        )
-        resolve(service)
-      })
-      debug(`Starting ${serviceName} discovery`)
-      browser.start()
-      return browser
-    }
-
-    this.browser = doStart('mqtt-n2k')
-  })
-}
-
-MQTTStream.prototype._transform = function (_data, _encoding, _callback) {}
-
-function moduleAvailable(name) {
-  try {
-    require.resolve(name)
-    return true
-    // eslint-disable-next-line no-empty
-  } catch (_e) {}
-  return false
-}
-
-module.exports.VenusMQTT = MQTTStream
-
-//const pgns = [ '126992','127505','129029','129291','130312','127245','127506','129038','129793','130314','127250','127508','129039','129794','130577','127251','128259','129040','129809','130842','127257','128267','129041','129810','127258','128275','129283','130306','127488','129025','129284','130310','127489','129026','129285','130311']

package/lib/venus.js

@@ -1,88 +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:venus')
-const Transform = require('stream').Transform
-const FromPgn = require('./fromPgn').Parser
-const _ = require('lodash')
-
-function VenusStream(options) {
-  if (!(this instanceof VenusStream)) {
-    return new VenusStream(options)
-  }
-
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  this.options = options
-
-  this.fromPgn = new FromPgn(options)
-
-  debug('created FromPgn')
-
-  /*
-  this.fromPgn.on('pgn', pgn => {
-  })
-*/
-
-  this.fromPgn.on('warning', (pgn, warning) => {
-    debug(`[warning] ${pgn.pgn} ${warning}`)
-  })
-
-  this.fromPgn.on('error', (pgn, error) => {
-    debug(`[error] ${pgn.pgn} ${error}`)
-  })
-
-  /*
-  if ( this.options.app ) {
-    options.app.on('nmea2000out', (msg) => {
-      that.sendActisensePGN(msg)
-    })
-    options.app.on('nmea2000JsonOut', (msg) => {
-      that.sendPGN(msg)
-    })
-
-    this.sendString('$PDGY,N2NET_OFFLINE')
-
-    debug('started')
-    //this.options.app.emit('nmea2000OutAvailable')
-  }
-  */
-}
-
-require('util').inherits(VenusStream, Transform)
-
-VenusStream.prototype._transform = function (pgn, encoding, done) {
-  //let line = chunk.toString().trim()
-  //line = line.substring(0, line.length) // take off the \r
-
-  this.fromPgn.parseVenusMQTT(pgn, (error, pgn) => {
-    if (!error) {
-      this.push(pgn)
-      this.options.app.emit(
-        this.options.analyzerOutEvent || 'N2KAnalyzerOut',
-        pgn
-      )
-    }
-
-    done()
-  })
-}
-
-VenusStream.prototype.end = function () {}
-
-module.exports.VenusStream = VenusStream

package/lib/w2k01.ts

@@ -1,142 +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.
- */
-
-import { PGN } from '@canboat/ts-pgns'
-import { createDebug } from './utilities'
-import { Transform } from 'stream'
-import {
-  pgnToActisenseN2KAsciiFormat,
-  actisenseToN2KAsciiFormat,
-  pgnToN2KActisenseFormat,
-  actisenseToN2KActisenseFormat
-} from './toPgn'
-import { readN2KActisense } from './n2k-actisense'
-import util from 'util'
-
-//const pgnsSent = {}
-
-const N2K_ASCII = 0
-const N2K_ACTISENSE = 1
-
-export function W2K01Stream(
-  this: any,
-  options: any,
-  type: string,
-  outEvent: string
-) {
-  if (this === undefined) {
-    return new (W2K01Stream as any)(options, type, outEvent)
-  }
-
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  this.debug = createDebug('canboatjs:w2k01', options)
-  this.debugData = createDebug('canboatjs:w2k01-data', options)
-
-  this.sentAvailable = false
-  this.options = options
-  this.outEvent = outEvent || 'w2k-1-out'
-
-  this.format = type === 'ascii' ? N2K_ASCII : N2K_ACTISENSE
-
-  if (this.format === N2K_ASCII) {
-    if (options.app) {
-      options.app.on(this.options.outEevent || 'nmea2000out', (msg: string) => {
-        if (typeof msg === 'string') {
-          this.sendW2KPGN(msg)
-        } else {
-          this.sendPGN(msg)
-        }
-        options.app.emit('connectionwrite', { providerId: options.providerId })
-      })
-
-      options.app.on(options.jsonOutEvent || 'nmea2000JsonOut', (msg: PGN) => {
-        this.sendPGN(msg)
-        options.app.emit('connectionwrite', { providerId: options.providerId })
-      })
-    }
-  }
-
-  this.debug('started')
-}
-
-W2K01Stream.prototype.send = function (msg: string | Buffer) {
-  this.debug('sending %s', msg)
-  this.options.app.emit(this.outEvent, msg)
-}
-
-W2K01Stream.prototype.sendPGN = function (pgn: PGN) {
-  //const now = Date.now()
-  //let lastSent = pgnsSent[pgn.pgn]
-  if (this.format === N2K_ASCII) {
-    const ascii = pgnToActisenseN2KAsciiFormat(pgn)
-    this.send(ascii + '\r\n')
-  } else {
-    const buf = pgnToN2KActisenseFormat(pgn)
-    this.send(buf)
-  }
-  //pgnsSent[pgn.pgn] = now
-}
-
-W2K01Stream.prototype.sendW2KPGN = function (msg: string) {
-  if (this.format === N2K_ASCII) {
-    const ascii = actisenseToN2KAsciiFormat(msg)
-    this.send(ascii + '\r\n')
-  } else {
-    const buf = actisenseToN2KActisenseFormat
-    this.send(buf)
-  }
-}
-
-util.inherits(W2K01Stream, Transform)
-
-W2K01Stream.prototype._transform = function (
-  chunk: any,
-  encoding: string,
-  done: any
-) {
-  if (!this.sentAvailable && this.format === N2K_ASCII) {
-    this.debug('emit nmea2000OutAvailable')
-    this.options.app.emit('nmea2000OutAvailable')
-    this.sentAvailable = true
-  }
-
-  if (this.format === N2K_ASCII) {
-    if (this.debugData.enabled) {
-      this.debugData('Received: ' + chunk)
-    }
-    this.push(chunk)
-  } else {
-    readN2KActisense(chunk, this.plainText, this, (data: any) => {
-      this.push(data)
-    })
-  }
-
-  done()
-}
-
-W2K01Stream.prototype.pipe = function (pipeTo: any) {
-  if (!pipeTo.fromPgn) {
-    this.plainText = true
-  } else {
-    this.plainText = false
-  }
-  return (W2K01Stream as any).super_.prototype.pipe.call(this, pipeTo)
-}
-
-W2K01Stream.prototype.end = function () {}

package/lib/yddevice.ts

@@ -1,48 +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 { PGN } from '@canboat/ts-pgns'
-import { N2kDevice } from './n2kDevice'
-import { actisenseToYdgwFullRawFormat } from './toPgn'
-
-export class YdDevice extends N2kDevice {
-  app: any
-  n2kOutEvent: string
-
-  constructor(options: any) {
-    super(options, 'canboatjs:yddevice')
-    this.app = options.app
-    this.n2kOutEvent = options.jsonOutEvent || 'nmea2000JsonOut'
-
-    const analyzerOutEvent = options.analyzerOutEvent || 'N2KAnalyzerOut'
-
-    this.app.on(analyzerOutEvent, this.n2kMessage.bind(this))
-  }
-
-  sendPGN(pgn: PGN, src: number | undefined = undefined) {
-    pgn.src = src || this.address
-
-    const ppgn = pgn as any //FIXME??
-    ppgn.ydFullFormat = true
-
-    this.debug('Sending PGN %j', pgn)
-    this.app.emit(this.n2kOutEvent, pgn)
-  }
-
-  sendActisenseFormat(msg: string) {
-    this.app.emit('ydFullRawOut', actisenseToYdgwFullRawFormat(msg))
-  }
-}