Skip to content

Commit

Permalink
NMEA-PARSER-NODERED: v1.0.0
Browse files Browse the repository at this point in the history
NMEA-PARSER-NODERED: v1.0.0
  • Loading branch information
core-marine authored May 20, 2024
2 parents 314ebe6 + 3b39d51 commit 0fd3a36
Show file tree
Hide file tree
Showing 34 changed files with 5,211 additions and 38,792 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/nmea-parser-nodered.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ jobs:
# run: "npm run nmea-parser-nodered:build"

- name: 🚀 Publish to npm
run: "npm publish --access public --workspace=@coremarine/nr-nmea-parser"
run: "npm publish --access public --workspace=@coremarine/nmea-parser-nodered"
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
3,488 changes: 1,790 additions & 1,698 deletions package-lock.json

Large diffs are not rendered by default.

28 changes: 8 additions & 20 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,41 +44,29 @@
"nmea-parser:build": "npm run build --workspace=@coremarine/nmea-parser",
"nmea-parser:test": "npm run test --workspace=@coremarine/nmea-parser",
"nmea-parser:test:coverage": "npm run test:coverage --workspace=@coremarine/nmea-parser",
"nmea-parser-nodered:lint": "npm run lint --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser-nodered:format": "npm run format --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser-nodered:build": "npm run build --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser-nodered:test": "npm run test --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser-nodered:test:coverage": "npm run test:coverage --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser:nodered:docker": "npm run docker --workspace=@coremarine/nmea-parser-nodered",
"nmea-parser:nodered:test": "npm run test --workspace=@coremarine/nmea-parser-nodered",
"norsub-emru:lint": "npm run lint --workspace=@coremarine/norsub-emru",
"norsub-emru:format": "npm run format --workspace=@coremarine/norsub-emru",
"norsub-emru:build": "npm run build --workspace=@coremarine/norsub-emru",
"norsub-emru:test": "npm run test --workspace=@coremarine/norsub-emru",
"norsub-emru:test:coverage": "npm run test:coverage --workspace=@coremarine/norsub-emru",
"norsub-emru-nodered:lint": "npm run lint --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru-nodered:format": "npm run format --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru-nodered:build": "npm run build --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru-nodered:test": "npm run test --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru-nodered:test:coverage": "npm run test:coverage --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru:nodered:docker": "npm run docker --workspace=@coremarine/norsub-emru-nodered",
"norsub-emru:nodered:test": "npm run test --workspace=@coremarine/norsub-emru-nodered",
"septentrio-sbf:lint": "npm run lint --workspace=@coremarine/sbf-parser",
"septentrio-sbf:format": "npm run format --workspace=@coremarine/sbf-parser",
"septentrio-sbf:build": "npm run build --workspace=@coremarine/sbf-parser",
"septentrio-sbf:test": "npm run test --workspace=@coremarine/sbf-parser",
"septentrio-sbf:coverage": "npm run test:coverage --workspace=@coremarine/sbf-parser",
"septentrio-sbf-nodered:lint": "npm run lint --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf-nodered:format": "npm run format --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf-nodered:build": "npm run build --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf-nodered:test": "npm run test --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf-nodered:test:coverage": "npm run test:coverage --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf:nodered:docker": "npm run docker --workspace=@coremarine/septentrio-sbf-nodered",
"septentrio-sbf:nodered:test": "npm run test --workspace=@coremarine/septentrio-sbf-nodered",
"thelmabiotel-tblive:lint": "npm run lint --workspace=@coremarine/thelmabiotel-tblive",
"thelmabiotel-tblive:format": "npm run format --workspace=@coremarine/thelmabiotel-tblive",
"thelmabiotel-tblive:build": "npm run build --workspace=@coremarine/thelmabiotel-tblive",
"thelmabiotel-tblive:test": "npm run test --workspace=@coremarine/thelmabiotel-tblive",
"thelmabiotel-tblive:test:coverage": "npm run test:coverage --workspace=@coremarine/thelmabiotel-tblive",
"thelmabiotel-tblive-nodered:lint": "npm run lint --workspace=@coremarine/thelmabiotel-tblive-nodered",
"thelmabiotel-tblive-nodered:format": "npm run format --workspace=@coremarine/thelmabiotel-tblive-nodered",
"thelmabiotel-tblive-nodered:build": "npm run build --workspace=@coremarine/thelmabiotel-tblive-nodered",
"thelmabiotel-tblive-nodered:test": "npm run test --workspace=@coremarine/thelmabiotel-tblive-nodered",
"thelmabiotel-tblive-nodered:test:coverage": "npm run test:coverage --workspace=@coremarine/thelmabiotel-tblive-nodered"
"thelmabiotel-tblive:nodered:docker": "npm run docker --workspace=@coremarine/thelmabiotel-tblive-nodered",
"thelmabiotel-tblive:nodered:test": "npm run test --workspace=@coremarine/thelmabiotel-tblive-nodered"
},
"devDependencies": {
"@types/node": "20.12.10",
Expand Down
Empty file modified packages/nmea-parser-nodered/.gitignore
100644 → 100755
Empty file.
28 changes: 8 additions & 20 deletions packages/nmea-parser-nodered/Dockerfile
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,25 +1,13 @@
FROM nodered/node-red:latest-18

USER root
RUN mkdir -p /components && chown node-red /components\
&& mkdir -p /config && chown node-red /config\
&& mkdir -p /db && chown node-red /db\
&& mkdir -p /static && chown node-red /static\
&& mkdir -p /tests && chown node-red /tests
USER node-red
# Copy package.json to the WORKDIR so npm builds all
# of your added nodes modules for Node-RED
# COPY ./data/package.json .

# ./
COPY ./package.json /components/package.json
COPY ./src/ /components/src/
# ./tests/nodered
# COPY ./../../package.json /tests/components/package.json
# COPY ./../../src/ /tests/components/src/
RUN mkdir -m 777 /components && chown node-red:node-red /components\
&& mkdir -m 777 /config && chown node-red:node-red /config \
&& mkdir -m 777 /db && chown node-red:node-red /db \
&& mkdir -m 777 /static && chown node-red:node-red /static \
&& mkdir -m 777 /tests && chown node-red:node-red /tests
COPY --chown=node-red:node-red --chmod=777 tests/nodered/components/ /components/

# RUN npm install --unsafe-perm --no-update-notifier --no-fund --only=production --loglevel=verbose
USER node-red

RUN npm install @coremarine/nmea-parser@1.6.2 /components
# RUN npm install @coremarine/nr-nmea-parser
# RUN npm install --production /tests/components
RUN npm i --production @coremarine/nmea-parser /components
Empty file modified packages/nmea-parser-nodered/LICENSE
100644 → 100755
Empty file.
24 changes: 12 additions & 12 deletions packages/nmea-parser-nodered/README.md
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# nr-nmea-parser
# NMEA-Parser-NodeRED

![npm (scoped)](https://img.shields.io/npm/v/%40coremarine/nr-nmea-parser)
[![publish](https://github.com/core-marine-dev/nr-nmea-parser/actions/workflows/publish.yml/badge.svg)](https://github.com/core-marine-dev/nr-nmea-parser/actions/workflows/publish.yml)
![npm](https://img.shields.io/npm/dy/%40coremarine/nr-nmea-parser)
![npm (scoped)](https://img.shields.io/npm/v/%40coremarine/nmea-parser-nodered)
[![publish](https://github.com/core-marine-dev/devices/actions/workflows/nmea-parser-nodered.yml/badge.svg)](https://github.com/core-marine-dev/devices/actions/workflows/nmea-parser-nodered.yml)
![npm](https://img.shields.io/npm/dy/%40coremarine/nmea-parser-nodered)

Node-Red component to read NMEA 0183 sentences. It is a wrapper of [@coremarine/nmea-parser](https://github.com/core-marine-dev/nmea-parser) (check it docs).
Node-Red component to read NMEA 0183 sentences. It is a wrapper of [@coremarine/nmea-parser](https://www.npmjs.com/package/@coremarine/nmea-parser) (check it docs).

## Input

Expand Down Expand Up @@ -38,7 +38,7 @@ Each input proerty would be responded in the same output property
NMEA parser translate NMEA ASCII string data into a JavaScript objects (one for each
NMEA 0183 sentence). Each time it receives data from payload input, it gives the parsed sentences to payload output.

It just a wrapper of the npm library [@coremarine/nmea-parser](https://github.com/core-marine-dev/nmea-parser) (take a look on it).
It just a wrapper of the npm library [@coremarine/nmea-parser](https://www.npmjs.com/package/@coremarine/nmea-parser) (take a look on it).

To interact with the *memory* | *protocols* | *sentence* API is through the `memory` | `protocols` | `sentence` property:

Expand Down Expand Up @@ -84,16 +84,16 @@ If you just want to know what are the known or supported sentences, you just nee
If you want to know if a sentence is known / supported, you need to send the sentence id.
Response will be an `object` with the whole info or `null` if it's unknown / not supported yet.

| Input | Output |
| :--------------------: | :-----------------------------: |
| `sentence`: **string** | `sentence`: **object** | `null` |
| Input | Output |
| :--------------------: | :------------------------------: |
| `sentence`: **string** | `sentence`: **object** \| `null` |

### Fake

If you want to get a NMEA-like sentence, maybe just to do some tests, you need to send the sentence id.
Response will be a `string` with the whole ASCII sentence or `null` if it's unknown / not supported yet.
This fake sentence is correct in terms of NMEA requirements but each field has garbage.

| Input | Output |
| :----------------: | :-------------------------: |
| `fake`: **string** | `fake`: **string** | `null` |
| Input | Output |
| :----------------: | :--------------------------: |
| `fake`: **string** | `fake`: **string** \| `null` |
9 changes: 6 additions & 3 deletions packages/nmea-parser-nodered/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
version: '3'
# version: '3'
name: nmea-parser

services:
nodered:
Expand All @@ -12,5 +13,7 @@ services:
- ./tests/nodered/data:/data
- ./tests/nodered/tests:/tests
# Components
- ./package.json:/components/package.json
- ./src/:/components/src/
# - ./package.json:/components/package.json
# - ./src/:/components/src/
# - ./package.json:/data/node_modules/@coremarine/nmea-parser-nodered/package.json
# - ./src/:/data/node_modules/@coremarine/nmea-parser-nodered/src/
Loading

0 comments on commit 0fd3a36

Please sign in to comment.