@meri-imperiumi/signalk-triplogger 1.0.0

package/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "airbnb-base"
+}

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: daily
+    versioning-strategy: increase-if-necessary
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly

package/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish Node.js Package
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - uses: actions/setup-node@v2.1.5
+        with:
+          node-version: 12
+      - run: npm install
+      - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.3.4
+      - uses: actions/setup-node@v2.1.5
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: Node CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    name: Run test suite
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12.x]
+    steps:
+    - uses: actions/checkout@v2.3.4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2.1.5
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm test
+      env:
+        CI: true
+  merge-me:
+    name: Auto-merge dependency updates
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: ridedott/merge-me-action@v2.9.103
+      with:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 meri-imperiumi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,10 @@
+# signalk-triplogger
+
+This plugin keeps automatic track of the distance traveled on the current trip. The distance tracked is based on vessel GPS positions, so it tracks distance over ground, not distance over water like traditional paddlewheel logs.
+
+The plugin monitors `vessel.state` as set by the [signalk-autostate](https://github.com/meri-imperiumi/signalk-autostate) plugin. Trip recording ends when vessel is detected as anchored or moored, and when vessel again gets under way, the trip log is reset to 0NM.
+
+## Changes
+
+* 1.0.0 (February 18th 2022)
+  - Initial version, logging in-memory only

package/index.js

@@ -0,0 +1,149 @@
+const { Point } = require('where');
+
+module.exports = (app) => {
+  const plugin = {};
+  let unsubscribes = [];
+  const log = {
+    trip: 0,
+    inTrip: false,
+    lastPosition: null,
+  };
+
+  plugin.id = 'signalk-triplogger';
+  plugin.name = 'Trip logger';
+  plugin.description = 'Log the length of the current trip';
+  const setStatus = app.setPluginStatus || app.setProviderStatus;
+
+  plugin.start = (options) => {
+    const subscription = {
+      context: 'vessels.self',
+      subscribe: [
+        {
+          path: 'navigation.state',
+          period: 1000,
+        },
+        {
+          path: 'navigation.position',
+          period: options.update_interval || 10000,
+        },
+      ],
+    };
+
+    function resetTrip() {
+      const resetTime = new Date();
+      log.trip = 0;
+      log.inTrip = true;
+      app.handleMessage(plugin.id, {
+        context: `vessels.${app.selfId}`,
+        updates: [
+          {
+            source: {
+              label: plugin.id,
+            },
+            timestamp: (new Date().toISOString()),
+            values: [
+              {
+                path: 'navigation.trip.log',
+                value: 0,
+              },
+              {
+                path: 'navigation.trip.lastReset',
+                value: resetTime,
+              },
+            ],
+          },
+        ],
+      });
+    }
+
+    function appendTrip(distance) {
+      log.trip += distance;
+      app.handleMessage(plugin.id, {
+        context: `vessels.${app.selfId}`,
+        updates: [
+          {
+            source: {
+              label: plugin.id,
+            },
+            timestamp: (new Date().toISOString()),
+            values: [
+              {
+                path: 'navigation.trip.log',
+                value: log.trip,
+              },
+            ],
+          },
+        ],
+      });
+    }
+
+    app.subscriptionmanager.subscribe(
+      subscription,
+      unsubscribes,
+      (subscriptionError) => {
+        app.error(`Error:${subscriptionError}`);
+      },
+      (delta) => {
+        if (!delta.updates) {
+          return;
+        }
+        delta.updates.forEach((u) => {
+          if (!u.values) {
+            return;
+          }
+          u.values.forEach((v) => {
+            if (v.path === 'navigation.state') {
+              // Potential state change
+              if (v.value === 'sailing' || v.value === 'motoring') {
+                if (!log.inTrip) {
+                  // New trip has started
+                  resetTrip();
+                  setStatus('New trip has started. Log reset');
+                }
+                // We can ignore switches between sailing and motoring inside trip
+              } else {
+                // Trip has ended, stop calculating log
+                log.inTrip = false;
+              }
+              return;
+            }
+            if (v.path === 'navigation.position') {
+              const newPosition = new Point(u.value.latitude, u.value.longitude);
+              if (log.lastPosition && log.inTrip) {
+                const distance = log.lastPosition.distanceTo(newPosition) * 1000;
+                appendTrip(distance);
+              }
+              const tripNm = log.trip / 1852;
+              if (log.inTrip) {
+                setStatus(`Trip under way, current distance ${tripNm}NM`);
+              } else {
+                setStatus(`Stopped. Last trip ${tripNm}NM`);
+              }
+              log.lastPosition = newPosition;
+            }
+          });
+        });
+      },
+    );
+
+    setStatus('Waiting for updates');
+  };
+
+  plugin.stop = () => {
+    unsubscribes.forEach((f) => f());
+    unsubscribes = [];
+  };
+
+  plugin.schema = {
+    type: 'object',
+    properties: {
+      update_interval: {
+        type: 'number',
+        default: 10000,
+        title: 'How often to update log, in milliseconds',
+      },
+    },
+  };
+
+  return plugin;
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@meri-imperiumi/signalk-triplogger",
+  "version": "1.0.0",
+  "description": "Log the length of the current trip",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "npm run lint"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/meri-imperiumi/signalk-triplogger.git"
+  },
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-category-utility"
+  ],
+  "signalk-plugin-enabled-by-default": true,
+  "author": "Henri Bergius <henri.bergius@iki.fi>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/meri-imperiumi/signalk-triplogger/issues"
+  },
+  "homepage": "https://github.com/meri-imperiumi/signalk-triplogger#readme",
+  "dependencies": {
+    "where": "^0.4.1"
+  },
+  "devDependencies": {
+    "eslint": "^7.14.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-plugin-import": "^2.18.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}