@canboat/canboatjs 3.0.2 → 3.2.2

package/.github/workflows/publish.yml

@@ -9,15 +9,24 @@ jobs:
     - uses: actions/checkout@v2
     - uses: actions/setup-node@v1
       with:
-        node-version: '18.x'
+        node-version: '22.x'
         registry-url: 'https://registry.npmjs.org'
-    - run: |
-          npm ci && npm cache clean --force
-          if [[ "$tag" == *beta* ]];
-            then
-              npm publish --tag beta
-            else
-              npm publish --access public
-          fi    
+
+    - name: Install and build 
+      run: |
+        npm cache clean -f
+        npm install
+        npm ci && npm cache clean --force
+        npm run build
+
+    - name: Publish 
+      run: |
+        npm ci && npm cache clean --force
+        if [[ "$tag" == *beta* ]];
+          then
+            npm publish --tag beta
+          else
+            npm publish --access public
+        fi    
       env:
         NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 22.x]
+        node-version: [20.x, 22.x]
 
     steps:
     - uses: actions/checkout@v3
@@ -25,4 +25,4 @@ jobs:
       with:
         node-version: ${{ matrix.node-version }}
     - run: npm install
-    - run: npm test
+    - run: npm run ci-test

package/.github/workflows/test_canboat_changes.yml

@@ -0,0 +1,91 @@
+name: Test Canboat json Changes
+
+on:
+  repository_dispatch:
+    types: [trigger-workflow]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+        
+    steps:
+    - name: Checkout canboatjs
+      uses: actions/checkout@v4
+      with:
+        path: ./canboatjs
+  
+    - name: Checkout canboat.json
+      uses: actions/checkout@v4
+      with:
+        repository: canboat/canboat
+        path: ./canboat
+        sparse-checkout: |
+          docs/canboat.json
+        sparse-checkout-cone-mode: false
+
+    - name: Checkout ts-pgns
+      uses: actions/checkout@v4
+      with:
+        repository: canboat/ts-pgns
+        path: ./ts-pgns
+  
+    - name: Checkout n2k-signalk
+      uses: actions/checkout@v4
+      with:
+        repository: SignalK/n2k-signalk
+        ref: typescript
+        path: ./n2k-signalk
+
+    - name: Checkout signalk-to-nmea2000
+      uses: actions/checkout@v4
+      with:
+        repository: SignalK/signalk-to-nmea2000
+        ref: typescript
+        path: ./signalk-to-nmea2000
+        
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        
+    - name: Build ts-pgns
+      run: |
+        cp ../canboat/docs/canboat.json .
+        npm install
+        npm run build
+        npm run generate
+        npm run build
+        npm link
+      working-directory: ./ts-pgns
+
+    - name: Test canboatjs
+      run: |
+        npm install
+        npm link @canboat/ts-pgns
+        npm run build
+        npm link
+        npm test
+      working-directory: ./canboatjs
+
+    - name: Test n2k-signalk
+      run: |
+        npm install
+        npm link @canboat/canboatjs
+        npm link @canboat/ts-pgns
+        npm run build
+        npm test
+      working-directory: ./n2k-signalk
+
+    - name: Test signalk-to-nmea2000
+      run: |
+        npm install
+        npm link @canboat/canboatjs
+        npm link @canboat/ts-pgns
+        npm test
+      working-directory: ./signalk-to-nmea2000
+

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx lint-staged --allow-empty

package/.mocharc.js

@@ -0,0 +1,7 @@
+module.exports = {
+  require: ['ts-node/register'],
+  extensions: ['ts', 'tsx', 'js'],
+  timeout: 20000,
+  exit: true,
+  recursive: true
+}

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "none"
+}

package/README.md

@@ -1,18 +1,13 @@
 # Canboatjs
 
 [![npm version](https://img.shields.io/npm/v/@canboat/canboatjs.svg)](https://www.npmjs.com/@canboat/canboatjs)
+[![Node.js CI & Test](https://github.com/canboat/canboatjs/actions/workflows/test.yml/badge.svg)](https://github.com/canboat/canboatjs/actions/workflows/test.yml)
+[![Test Canboat json Changes](https://github.com/canboat/canboatjs/actions/workflows/test_canboat_changes.yml/badge.svg)](https://github.com/canboat/canboatjs/actions/workflows/test_canboat_changes.yml)
 
 Pure javascript NMEA 2000 decoder and encoder
 
 Canboatjs is a port of the canboat project (https://github.com/canboat/canboat) to javascript
 
-# Contributors
-
-- Scott Bender <scott@scottbender.net>
-- Kees Verruijt <kees@verruijt.net>
-- Jouni Hartikainen <jouni.hartikainen@iki.fi>
-- Teppo Kurki <teppo.kurki@iki.fi>
-
 # Features
 
 - Reads directly from CAN bus devices and NMEA 2000 gateways including:
@@ -20,12 +15,13 @@ Canboatjs is a port of the canboat project (https://github.com/canboat/canboat)
   - Digital Yacht iKonvert
   - Yacht Devices YDWG-02 and YDEN-02
   - Shipmodul MiniPlex-3-N2K
+  - socketcan based devices
 - Parses input in canboat analyzer json format
 - Converts and outputs binary N2K format to supported devices
 
 # PGN Descriptions
 
-The details about the PGNs recognized by Canboatjs come from the canboat project in [pgns.json](https://github.com/canboat/canboat/blob/master/analyzer/pgns.json). If you want to add or update PGN details, please make changes to the [pgn.h file](https://github.com/canboat/canboat/blob/master/analyzer/pgn.h) in canboat and submit a pull request there. Include sample data and raise an issue here so that I can include your changes in Canboatjs.
+The details about the PGNs recognized by Canboatjs come from the canboat project in [canboat.json](https://github.com/canboat/canboat/blob/master/docs/canboat.json). If you want to add or update PGN details, please make changes to the [pgn.h file](https://github.com/canboat/canboat/blob/master/analyzer/pgn.h) in canboat and submit a pull request there. Include sample data and raise an issue here so that I can include your changes in Canboatjs.
 
 # Command Line Programs
 
@@ -39,17 +35,12 @@ Examples:
 - `ikonvert-serial /dev/ttyUSB0 | analyzerjs`
 - `nc ydgw 1475 | analyzerjs`
 - `nc w2k-1 6002 | analyzerjs` // port should be N2K ACSCII format server on a w2k-1
+-  `candump can0 | analyzerjs`
 
 ## to-pgn
 
 This program takes input in the canboat json format and outputs actisense serial format.
 
-## candumpanalyzer
-
-This program takes input in the candump format and outputs canboat json format
-
-Example: `candump can0 | candumpanalyzerjs`
-
 ## candumpjs
 
 Read directly from a socketcan device without the need to install can-utils

package/dist/actisense-serial.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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.
+ */
+export declare function ActisenseStream(this: any, options: any): any;
+//# sourceMappingURL=actisense-serial.d.ts.map

package/dist/actisense-serial.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actisense-serial.d.ts","sourceRoot":"","sources":["../lib/actisense-serial.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AA0CH,wBAAgB,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,OAkCtD"}