@signalk/streams 5.1.3 → 6.0.0

package/nmea0183-signalk.js

@@ -1,119 +0,0 @@
-/*
- * Copyright 2017 Signal K & Fabian Tollenaar <fabian@signalk.org>
- *
- * 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 the pipeElement that transforms NMEA0183 input to Signal K deltas.
- * Emits sentence data as "nmea0183" events on app and app.signalk by default.
- * Furthermore you can use "sentenceEvent" option, that will cause sentence data to be
- * emitted as events on app. sentenceEvent can be a string or an array of strings.
- *
- * Example:
- * {
- *   "type": "providers/nmea0183-signalk",
- *   "options": {
- *     "sentenceEvent": "nmea0183-B"
- *   },
- * }
- */
-
-const Transform = require('stream').Transform
-const Parser = require('@signalk/nmea0183-signalk')
-const utils = require('@signalk/nmea0183-utilities')
-const n2kToDelta = require('@signalk/n2k-signalk').toDelta
-const FromPgn = require('@canboat/canboatjs').FromPgn
-
-function Nmea0183ToSignalK(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-  this.debug = (options.createDebug || require('debug'))(
-    'signalk:streams:nmea0183-signalk'
-  )
-
-  this.parser = new Parser(options)
-  this.n2kParser = new FromPgn(options)
-  this.n2kState = {}
-
-  // Object on which to send 'sentence' events
-  this.app = options.app
-
-  // Prepare a list of events to send for each sentence received
-  this.sentenceEvents = options.suppress0183event ? [] : ['nmea0183']
-  this.appendChecksum = options.appendChecksum
-
-  if (options.sentenceEvent) {
-    if (Array.isArray(options.sentenceEvent)) {
-      this.sentenceEvents = this.sentenceEvents.concat(options.sentenceEvent)
-    } else {
-      this.sentenceEvents.push(options.sentenceEvent)
-    }
-  }
-}
-
-require('util').inherits(Nmea0183ToSignalK, Transform)
-
-Nmea0183ToSignalK.prototype._transform = function (chunk, encoding, done) {
-  let sentence
-  let timestamp = null
-
-  if (chunk && typeof chunk === 'object' && typeof chunk.line === 'string') {
-    timestamp = new Date(Number(chunk.timestamp))
-    sentence = chunk.line.trim()
-  } else if (Buffer.isBuffer(chunk)) {
-    sentence = chunk.toString().trim()
-  } else if (chunk && typeof chunk === 'string') {
-    sentence = chunk.trim()
-  }
-
-  try {
-    if (sentence !== undefined) {
-      if (this.appendChecksum) {
-        sentence = utils.appendChecksum(sentence)
-      }
-      // Send 'sentences' event to the app for each sentence
-      this.sentenceEvents.forEach((eventName) => {
-        this.app.emit(eventName, sentence)
-        this.app.signalk.emit(eventName, sentence)
-      })
-
-      let delta = null
-      if (this.n2kParser.isN2KOver0183(sentence)) {
-        const pgn = this.n2kParser.parseN2KOver0183(sentence)
-        if (pgn) {
-          delta = n2kToDelta(pgn, this.state, { sendMetaData: true })
-        }
-      } else {
-        delta = this.parser.parse(sentence)
-      }
-
-      if (delta !== null) {
-        if (timestamp !== null) {
-          delta.updates.forEach((update) => {
-            update.timestamp = timestamp
-          })
-        }
-
-        this.push(delta)
-      }
-    }
-  } catch (e) {
-    this.debug(e)
-  }
-
-  done()
-}
-
-module.exports = Nmea0183ToSignalK

package/nullprovider.js

@@ -1,31 +0,0 @@
-/*
- *
- * prototype-server: An implementation of a Signal K server for boats.
- * Copyright (C) 2017 Teppo Kurki <teppo.kurki@iki.fi>.
- *
- * 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/>.
- *
- */
-
-const Transform = require('stream').Transform
-
-function NullProvider() {
-  Transform.call(this, {
-    objectMode: true
-  })
-}
-
-require('util').inherits(NullProvider, Transform)
-
-module.exports = NullProvider

package/replacer.js

@@ -1,57 +0,0 @@
-/*
- * Copyright 2020 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.
- */
-
-const Transform = require('stream').Transform
-
-require('util').inherits(Replacer, Transform)
-
-function Replacer(options) {
-  Transform.call(this, {
-    objectMode: true
-  })
-  this.doPush = this.push.bind(this)
-  this.regexp = new RegExp(options.regexp, 'gu')
-  this.template = options.template
-}
-
-Replacer.prototype._transform = function (chunk, encoding, done) {
-  this.doPush(chunk.toString().replace(this.regexp, this.template))
-  done()
-}
-
-module.exports = Replacer
-
-// const replacers = [
-//   {
-//     regexp: '\u0000',
-//     template: '',
-//     testdata: '\u0000$WIMWV,1\u000047,R,0,N,A21',
-//     testresult: '$WIMWV,147,R,0,N,A21'
-//   }
-//   ,
-//   {
-//     regexp: '^...RMC.*',
-//     template: '',
-//     testdata: '$GPRMC,123519,A,4807.038,N,01131.000,E,022.4,084.4,230394,003.1,W*6A',
-//     testresult: ''
-//   }
-// ]
-
-// replacers.forEach(replacerOptions => {
-//   const replacer = new Replacer(replacerOptions)
-//   replacer.doPush = x => console.log(JSON.stringify(x))
-//   replacer._transform(replacerOptions.testdata, null, () => {})
-// })

package/s3.js

@@ -1,87 +0,0 @@
-/*
- * Copyright 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.
- */
-
-var Transform = require('stream').Transform
-/*
-  aws-sdk is not included in dependencies because of the
-  persistent deprecation warnings caused by its transitive
-  dependencies. This feature is not in wide use, especially
-  not in signalk-server where people encounter the scary looking
-  deprecation warnings.
-  Known to work with ^2.413.0
-*/
-const AWS = require('aws-sdk')
-
-function S3Provider({ bucket, prefix }) {
-  Transform.call(this, {
-    objectMode: false
-  })
-  this.Bucket = bucket
-  this.Prefix = prefix
-  // AWS.config.credentials = new AWS.SharedIniFileCredentials()
-}
-
-require('util').inherits(S3Provider, Transform)
-
-S3Provider.prototype.pipe = function (pipeTo) {
-  const doEnd = this.end.bind(this)
-  const s3 = new AWS.S3()
-  const params = {
-    Bucket: this.Bucket,
-    Prefix: this.Prefix
-  }
-  console.log('listobjects')
-  s3.listObjects(params)
-    .promise()
-    .then((data) => {
-      // console.log(data)
-      const jobs = data.Contents.map(
-        (item, i) =>
-          function () {
-            return new Promise((resolve) => {
-              console.log('Starting key ' + item.Key)
-              const objectParams = {
-                Bucket: params.Bucket,
-                Key: item.Key
-              }
-              const request = s3.getObject(objectParams)
-              request.on('error', (err) => {
-                console.log(err)
-              })
-              const stream = request.createReadStream()
-              stream.on('end', resolve)
-              stream.pipe(pipeTo, { end: i === data.Contents.length - 1 })
-            })
-          }
-      )
-
-      let i = 0
-      function startNext() {
-        if (i < jobs.length) {
-          jobs[i++]().then(startNext)
-        } else {
-          doEnd()
-        }
-      }
-      startNext()
-    })
-    .catch((error) => {
-      console.error(error)
-    })
-  return pipeTo
-}
-
-module.exports = S3Provider

package/serialport.js

@@ -1,209 +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 the first pipeElement in a PipedProvider. Used to pass data input from Serial
- * to the next pipeElement.
- * Reads data from a serial device and allows writing back to serial with the "toStdout" option
- * It takes two options; "device" and "baudrate".
- *
- * The "toStdout" option is not mandatory. It routes events emitted on app with that name to
- * serial output, followed by newline. toStdout can be a string or an array of strings.
- *
- * You can run arbitrary shell command that get the configured serial port as the parameter
- * by setting the environment variable PRESERIALCOMMAND. The command is invoked once per each
- * configured serial port.
- *
- * For example running the server having run
- *
- * export PRESERIALCOMMAND="echo >>/tmp/serialports"
- *
- * will append all configured serial port devices to the file /tmp/serialports
- * every time the server is started.
- *
- * Example:
-
- {
-   "type": "providers/serialport",
-   "options": {
-     "device": "/dev/ttyUSB0",
-     "baudrate": 4800,
-     "toStdout": "nmea0183out1"
-   },
-   "optionMappings": [
-     {
-       "fromAppProperty": "argv.nmeadevice",
-       "toOption": "device"
-     },
-
-     {
-       "fromAppProperty": "argv.nmeabaudrate",
-       "toOption": "baudrate"
-     }
-   ]
- },
-
- */
-
-const Transform = require('stream').Transform
-const child_process = require('child_process')
-const shellescape = require('any-shell-escape')
-const { SerialPort } = require('serialport')
-const { ReadlineParser } = require('@serialport/parser-readline')
-const isArray = require('lodash').isArray
-const isBuffer = require('lodash').isBuffer
-
-function SerialStream(options) {
-  if (!(this instanceof SerialStream)) {
-    return new SerialStream(options)
-  }
-
-  Transform.call(this, options)
-
-  this.reconnect = options.reconnect || true
-  this.reconnectDelay = 1000
-  this.serial = null
-  this.options = options
-  this.maxPendingWrites = options.maxPendingWrites || 5
-  this.start()
-  this.isFirstError = true
-
-  const createDebug = options.createDebug || require('debug')
-  this.debug = createDebug('signalk:streams:serialport')
-
-  let pendingWrites = 0
-  const stdOutEvents = isArray(this.options.toStdout)
-    ? this.options.toStdout
-    : [this.options.toStdout]
-  const standardOutEventName = `serial-${this.options.providerId}-toStdout`
-  stdOutEvents.push(standardOutEventName)
-
-  const that = this
-  stdOutEvents.forEach((event) => {
-    const onDrain = () => {
-      pendingWrites--
-    }
-
-    that.options.app.on(event, (d) => {
-      if (pendingWrites > that.maxPendingWrites) {
-        that.debug('Buffer overflow, not writing:' + d)
-        return
-      }
-      that.debug('Writing:' + d)
-      if (isBuffer(d)) {
-        that.serial.write(d)
-      } else {
-        that.serial.write(d + '\r\n')
-      }
-      setImmediate(() => {
-        that.options.app.emit('connectionwrite', {
-          providerId: that.options.providerId
-        })
-      })
-      pendingWrites++
-      that.serial.drain(onDrain)
-    })
-  })
-
-  this.options.app.emitPropertyValue('serialport', {
-    id: this.options.providerId,
-    eventNames: {
-      toStdout: standardOutEventName
-    }
-  })
-}
-
-require('util').inherits(SerialStream, Transform)
-
-SerialStream.prototype.start = function () {
-  if (this.serial !== null) {
-    this.serial.unpipe(this)
-    this.serial.removeAllListeners()
-    this.serial = null
-  }
-
-  if (this.reconnect === false) {
-    return
-  }
-
-  if (process.env.PRESERIALCOMMAND) {
-    child_process.execSync(
-      `${process.env.PRESERIALCOMMAND} ${shellescape(this.options.device)}`
-    )
-  }
-
-  this.serial = new SerialPort({
-    path: this.options.device,
-    baudRate: this.options.baudrate
-  })
-
-  this.serial.on(
-    'open',
-    function () {
-      this.reconnectDelay = 1000
-      this.options.app.setProviderStatus(
-        this.options.providerId,
-        `Connected to ${this.options.device}`
-      )
-      this.isFirstError = true
-      const parser = new ReadlineParser()
-      this.serial.pipe(parser).pipe(this)
-    }.bind(this)
-  )
-
-  this.serial.on(
-    'error',
-    function (x) {
-      this.options.app.setProviderError(this.options.providerId, x.message)
-      if (this.isFirstError) {
-        console.log(x.message)
-      }
-      this.debug(x.message)
-      this.isFirstError = false
-      this.scheduleReconnect()
-    }.bind(this)
-  )
-  this.serial.on(
-    'close',
-    function () {
-      this.options.app.setProviderError(
-        this.options.providerId,
-        'Closed, reconnecting...'
-      )
-      this.scheduleReconnect()
-    }.bind(this)
-  )
-}
-
-SerialStream.prototype.end = function () {
-  this.serial.close()
-}
-
-SerialStream.prototype._transform = function (chunk, encoding, done) {
-  this.push(chunk)
-  done()
-}
-
-SerialStream.prototype.scheduleReconnect = function () {
-  this.reconnectDelay *= this.reconnectDelay < 60 * 1000 ? 1.5 : 1
-  const msg = `Not connected (retry delay ${(
-    this.reconnectDelay / 1000
-  ).toFixed(0)} s)`
-  this.debug(msg)
-  this.options.app.setProviderStatus(this.options.providerId, msg)
-  setTimeout(this.start.bind(this), this.reconnectDelay)
-}
-
-module.exports = SerialStream