@signalk/streams 5.1.3 → 6.0.0

package/execute.js

@@ -1,137 +0,0 @@
-/*
- *
- * prototype-server: An implementation of a Signal K server for boats.
- * Copyright (C) 2014  Fabian Tollenaar <fabian@starting-point.nl>,
- * Teppo Kurki <teppo.kurki@iki.fi> *et al*.
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
-/* Usage:
- * As part of a PipedProvider in a settings file. Lets you pass a command to the server, as set in the options.
- * Also allows writing to stdout, for example with actisense-serial N2K data
- * see https://github.com/tkurki/cassiopeia-settings/blob/master/signalk-server-settings.json
- * Example from https://github.com/SignalK/signalk-server-node/blob/master/settings/actisense-serial-settings.json#L12
-
-  {
-   "type": "providers/execute",
-      "options": {
-        "command": "actisense-serial /dev/tty.usbserial-1FD34"
-      }
-  }
-
- *
- * It may also be other commands such as "./aisdeco --gain 33.8 --freq-correction 60 --freq 161975000 --freq 162025000 --net 30007 --udp 5.9.207.224:5351" for starting an AID reception with a USB SRD dongle
- */
-
-const Transform = require('stream').Transform
-const { pgnToActisenseSerialFormat } = require('@canboat/canboatjs')
-
-function Execute(options) {
-  Transform.call(this, {})
-  this.options = options
-  const createDebug = options.createDebug || require('debug')
-  this.debug = options.debug || createDebug('signalk:streams:execute')
-}
-
-require('util').inherits(Execute, Transform)
-
-Execute.prototype._transform = function (chunk, encoding, done) {
-  this.analyzerProcess.stdin.write(chunk.toString())
-  done()
-}
-function start(command, that) {
-  that.debug(`starting |${command}|`)
-  if (process.platform === 'win32') {
-    that.childProcess = require('child_process').spawn('cmd', ['/c', command])
-  } else {
-    that.childProcess = require('child_process').spawn('sh', ['-c', command])
-  }
-  that.lastStartupTime = new Date().getTime()
-  that.options.app.setProviderStatus(that.options.providerId, 'Started')
-
-  that.childProcess.stderr.on('data', function (data) {
-    const msg = data.toString()
-    that.options.app.setProviderError(that.options.providerId, msg)
-    console.error(msg)
-  })
-
-  that.childProcess.stdout.on('data', function (data) {
-    if (that.debug.enabled) {
-      that.debug(data.toString())
-    }
-    that.push(data)
-  })
-
-  that.childProcess.on('close', (code) => {
-    const msg = `|${command}| exited with ${code}`
-    // that.options.app.setProviderError(that.options.providerId, msg)
-    console.error(msg)
-    if (
-      typeof that.options.restartOnClose === 'undefined' ||
-      that.options.restartOnClose
-    ) {
-      const throttleTime = (that.options.restartThrottleTime || 60) * 1000
-
-      const sinceLast = new Date().getTime() - that.lastStartupTime
-      if (sinceLast > throttleTime) {
-        start(command, that)
-      } else {
-        const nextStart = throttleTime - sinceLast
-        const msg = `Waiting ${nextStart / 1000} seconds to restart`
-        that.options.app.setProviderStatus(that.options.providerId, msg)
-        that.debug(msg)
-        setTimeout(function () {
-          start(command, that)
-        }, nextStart)
-      }
-    }
-  })
-}
-
-Execute.prototype.pipe = function (pipeTo) {
-  this.pipeTo = pipeTo
-  start(this.options.command, this)
-
-  const stdOutEvent = this.options.toChildProcess || 'toChildProcess'
-  this.debug(
-    'Using event ' + stdOutEvent + " for output to child process's stdin"
-  )
-  const that = this
-  that.options.app.on(stdOutEvent, function (d) {
-    try {
-      that.childProcess.stdin.write(d + '\n')
-    } catch (err) {
-      console.log('execute:' + err.message)
-    }
-  })
-
-  if (stdOutEvent === 'nmea2000out') {
-    that.options.app.on('nmea2000JsonOut', (pgn) => {
-      that.childProcess.stdin.write(pgnToActisenseSerialFormat(pgn) + '\r\n')
-    })
-    that.options.app.emit('nmea2000OutAvailable')
-  }
-
-  Execute.super_.prototype.pipe.call(this, pipeTo)
-}
-
-Execute.prototype.end = function () {
-  this.debug('end, killing child  process')
-  this.childProcess.kill()
-  this.pipeTo.end()
-}
-
-module.exports = Execute

package/filestream.js

@@ -1,90 +0,0 @@
-/*
- * Copyright 2014-2015 Fabian Tollenaar <fabian@starting-point.nl>
- *
- * 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.
- */
-
-/*  Usage:
- * As part of a PipedProvider in a settings file. Lets the server read from a file, as set in the options:
- * Example from https://github.com/SignalK/signalk-server-node/blob/master/settings/volare-file-settings.json#L23-L34
-
-{
- "type": "providers/filestream",
- "options": {
-   "filename": "samples/plaka.log"
- },
- "optionMappings": [
-   {
-     "fromAppProperty": "argv.nmeafilename",
-     "toOption": "filename"
-   }
- ]
-},
-
- */
-
-const path = require('path')
-const PassThrough = require('stream').PassThrough
-const fs = require('fs')
-
-function EndIgnoringPassThrough() {
-  PassThrough.call(this)
-}
-
-require('util').inherits(EndIgnoringPassThrough, PassThrough)
-EndIgnoringPassThrough.prototype.end = function () {}
-
-const FileStream = function (options) {
-  this.options = options
-  this.keepRunning =
-    typeof options.keepRunning === 'undefined' ? true : options.keepRunning
-}
-
-FileStream.prototype.pipe = function (pipeTo) {
-  this.pipeTo = pipeTo
-  this.endIgnoringPassThrough = new EndIgnoringPassThrough()
-  this.endIgnoringPassThrough.pipe(pipeTo)
-  this.startStream()
-}
-
-FileStream.prototype.startStream = function () {
-  let filename
-  if (path.isAbsolute(this.options.filename)) {
-    filename = this.options.filename
-  } else {
-    filename = path.join(
-      this.options.app.config.configPath,
-      this.options.filename
-    )
-    if (!fs.existsSync(filename)) {
-      filename = path.join(__dirname, '..', this.options.filename)
-    }
-  }
-
-  this.filestream = require('fs').createReadStream(filename)
-  this.filestream.on('error', (err) => {
-    console.error(err.message)
-    this.keepRunning = false
-  })
-  if (this.keepRunning) {
-    this.filestream.on('end', this.startStream.bind(this))
-  }
-  this.filestream.pipe(this.endIgnoringPassThrough)
-}
-
-FileStream.prototype.end = function () {
-  this.pipeTo.end()
-  this.filestream.close()
-}
-
-module.exports = FileStream

package/folderstream.js

@@ -1,36 +0,0 @@
-const Transform = require('stream').Transform
-const fs = require('fs')
-
-function FolderStreamProvider(folder) {
-  Transform.call(this, {
-    objectMode: false
-  })
-  this.folder = folder
-  this.fileIndex = 0
-}
-
-require('util').inherits(FolderStreamProvider, Transform)
-
-FolderStreamProvider.prototype.pipe = function (pipeTo) {
-  const files = fs.readdirSync(this.folder)
-  pipeNextFile.bind(this)()
-
-  function pipeNextFile() {
-    const fileStream = fs.createReadStream(
-      this.folder + '/' + files[this.fileIndex]
-    )
-    fileStream.pipe(pipeTo, { end: false })
-    fileStream.on('end', () => {
-      this.fileIndex++
-      if (this.fileIndex === files.length) {
-        pipeTo.end()
-      } else {
-        pipeNextFile.bind(this)()
-      }
-    })
-  }
-
-  return pipeTo
-}
-
-module.exports = FolderStreamProvider

package/from_json.js

@@ -1,51 +0,0 @@
-/*
- * Copyright 2014-2015 Fabian Tollenaar <fabian@starting-point.nl>
- *
- * 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.
- */
-
-/* Usage:
- * As part of a PipedProvider in a settings file. Lets you pass json strings such as Signal K deltas coming from other sources such as TCP, UDP, Serial etc. Usually last in the list of providers for this pipe
- * Takes no options:
-
- {
-   "type": "providers/from_json"
- },
-
- *
- */
-
-const Transform = require('stream').Transform
-
-function FromJson() {
-  Transform.call(this, {
-    objectMode: true
-  })
-}
-
-require('util').inherits(FromJson, Transform)
-
-FromJson.prototype._transform = function (chunk, encoding, done) {
-  let parsed = null
-  try {
-    parsed = JSON.parse(chunk.toString())
-  } catch (_) {
-    console.error('Could not parse JSON:' + chunk.toString())
-  }
-  if (parsed) {
-    this.push(parsed)
-  }
-  done()
-}
-
-module.exports = FromJson

package/gpsd.js

@@ -1,94 +0,0 @@
-/*
- * Copyright 2014-2015 Teppo Kurki <teppo.kurki@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.
- */
-
-/* Usage:
- * As part of a PipedProvider in a settings file. Lets you pass gpsd to Signal K. GPSD is a service daemon that monitors one or more GPSes or AIS receivers attached to a host computer through serial or USB ports,
- * making all data on the location/course/velocity of the sensors available to be queried on TCP port 2947 of the host computer.
- * For examples of use, see https://github.com/SignalK/signalk-server-node/blob/master/settings/volare-gpsd-settings.json
- * Takes the options "port" (default 2947) and "hostname" (default 'localhost')
-
- {
-  "type": "providers/gpsd",
-  "options": {
-    "port": 2947,
-    "hostname": "localhost"
-  },
- },
-
- */
-
-const Transform = require('stream').Transform
-const GpsdClient = require('node-gpsd-client')
-
-function Gpsd(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  const port = options.port || 2947
-  const hostname = options.hostname || options.host || 'localhost'
-  const noDataReceivedTimeout = options.noDataReceivedTimeout || 0
-
-  function setProviderStatus(msg) {
-    options.app.setProviderStatus(options.providerId, msg)
-  }
-
-  const createDebug = options.createDebug || require('debug')
-
-  this.listener = new GpsdClient({
-    port: port,
-    hostname: hostname,
-    logger: {
-      info: createDebug('signalk:streams:gpsd'),
-      warn: console.warn,
-      error: (msg) => {
-        options.app.setProviderError(
-          options.providerId,
-          `${hostname}:${port}: ` + msg
-        )
-      }
-    },
-    parse: false,
-    reconnectThreshold: noDataReceivedTimeout,
-    reconnectInterval: noDataReceivedTimeout / 2
-  })
-
-  setProviderStatus(`Connecting to ${hostname}:${port}`)
-
-  this.listener.on('connected', () => {
-    setProviderStatus(`Connected to ${hostname}:${port}`)
-    this.listener.watch({
-      class: 'WATCH',
-      nmea: true,
-      json: false
-    })
-  })
-
-  const self = this
-  this.listener.on('raw', function (data) {
-    self.push(data)
-  })
-
-  this.listener.connect()
-}
-
-require('util').inherits(Gpsd, Transform)
-
-Gpsd.prototype._transform = function (chunk, encoding, done) {
-  done()
-}
-
-module.exports = Gpsd

package/keys-filter.js

@@ -1,81 +0,0 @@
-'use strict'
-
-const Transform = require('stream').Transform
-
-function ToSignalK(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  const createDebug = options.createDebug || require('debug')
-  this.debug = createDebug('signalk:streams:keys-filter')
-  this.exclude = options.excludeMatchingPaths
-}
-
-require('util').inherits(ToSignalK, Transform)
-
-ToSignalK.prototype._transform = function (chunk, encoding, done) {
-  // Chunck is a delta. Check options if any of the paths need to be filtered...
-  let delta = null
-  let string = false
-
-  if (typeof chunk === 'object' && chunk !== null) {
-    delta = chunk
-  } else if (typeof chunk === 'string') {
-    try {
-      delta = JSON.parse(chunk)
-      string = true
-    } catch (e) {
-      this.debug(`Error parsing chunk: ${e.message}`)
-    }
-  }
-
-  if (Array.isArray(delta.updates)) {
-    const updates = []
-    delta.updates.forEach((update) => {
-      if (Array.isArray(update.values)) {
-        const values = []
-
-        update.values.forEach((value) => {
-          if (this.exclude.includes(value.path) !== true) {
-            values.push(value)
-          }
-        })
-
-        if (values.length > 0) {
-          const upd = {
-            values
-          }
-
-          if (update.$source) {
-            upd.$source = update.$source
-          }
-
-          if (update.source) {
-            upd.source = update.source
-          }
-
-          if (update.timestamp) {
-            upd.timestamp = update.timestamp
-          }
-
-          updates.push(upd)
-        }
-      }
-    })
-
-    if (updates.length > 0) {
-      delta.updates = updates
-
-      if (string === true) {
-        delta = JSON.stringify(delta)
-      }
-
-      this.push(delta)
-    }
-  }
-
-  done()
-}
-
-module.exports = ToSignalK

package/liner.js

@@ -1,68 +0,0 @@
-/*
- * Copyright 2014-2015 Fabian Tollenaar <fabian@starting-point.nl>
- *
- * 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.
- */
-
-/* Usage:
- *  This is part of a PipedProvider that splits the input into separate lines and passes one line at a time to the next provider.
- *  You can specify the line separator with the option lineSeparator.
-
- {
-   "type": "providers/liner"
- },
-
- */
-
-const Transform = require('stream').Transform
-
-require('util').inherits(Liner, Transform)
-
-function Liner(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-  this.doPush = this.push.bind(this)
-  this.lineSeparator = options.lineSeparator || '\n'
-}
-
-Liner.prototype._transform = function (chunk, encoding, done) {
-  let data = chunk.toString()
-  if (this._lastLineData) {
-    data = this._lastLineData + data
-  }
-
-  const lines = data.split(this.lineSeparator)
-  this._lastLineData = lines.splice(lines.length - 1, 1)[0]
-  if (this._lastLineData.length > 2048) {
-    console.error(
-      'Are you sure you are using the correct line terminator? Not going to handle lines longer than 2048 chars.'
-    )
-    this._lastLineData = ''
-  }
-
-  lines.forEach(this.doPush)
-
-  done()
-}
-
-Liner.prototype._flush = function (done) {
-  if (this._lastLineData) {
-    this.push(this._lastLineData)
-  }
-
-  this._lastLineData = null
-  done()
-}
-
-module.exports = Liner

package/log.js

@@ -1,51 +0,0 @@
-/*
- * Copyright 2016 Teppo Kurki <teppo.kurki@ıki.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.
- */
-
-/* Usage: This  pipeElement logs the output of the previous pipeElement. If placed in the end of the pipe, it will log Signal K deltas
- * Takes the options "logdir" and "discriminator". The log files are named from date and hour, and a new file is created every hour
- * Please note the standard discriminators used for playback with providers/multiplexedlog.js
- * Example:
-
-{
-  "type": "providers/log",
-  "options": {
-    "logdir": "logs",
-    "discriminator": "I"
-  }
-}
-
-*/
-
-const Transform = require('stream').Transform
-const getLogger = require('./logging').getLogger
-
-function Log(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-
-  this.logger = getLogger(options.app, options.discriminator, options.logdir)
-}
-
-require('util').inherits(Log, Transform)
-
-Log.prototype._transform = function (msg, encoding, done) {
-  this.push(msg)
-  this.logger(msg)
-  done()
-}
-
-module.exports = Log