@signalk/nmea0183-utilities - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0

index.js

 'use strict';
 
-(function() {
+(function () {
 
@@ -36,3 +36,11 @@ var utils = {};
 
-  exports.valid = function(sentence, validateChecksum) {
+  function checksum(sentencePart) {
+    let check = 0;
+    for (let i = 1; i < sentencePart.length; i++) {
+      check = check ^ sentencePart.charCodeAt(i);
+    };
+    return check;
+  }
+
+  exports.valid = function (sentence, validateChecksum) {
     sentence = String(sentence).trim();
@@ -47,11 +55,5 @@
     if ((sentence.charAt(0) == '$' || sentence.charAt(0) == '!') && (validateChecksum == false || sentence.charAt(sentence.length - 3) == '*')) {
-      if ( validateChecksum ) {
-        var check = 0;
-        var split = sentence.split('*');
-        
-        for (var i = 1; i < split[0].length; i++) {
-          check = check ^ split[0].charCodeAt(i);
-        };
-        
-        return (parseInt(split[1], 16) == check);
+      if (validateChecksum) {
+        let split = sentence.split('*');
+        return (parseInt(split[1], 16) == checksum(split[0]));
       } else {
@@ -61,7 +63,16 @@ return true
     }
-
     return false;
   };
 
-  exports.source = function(sentence) {
+  exports.appendChecksum = function (sentence) {
+    let split = String(sentence).trim().split('*');
+    if (split.length === 1) {
+      if (split[0].charAt(0) == '$' || split[0].charAt(0) == '!') {
+        return split[0].concat('*').concat(checksum(split[0]).toString(16).padStart(2, '0').toUpperCase());
+      }
+    }
+    return sentence;
+  };
+
+  exports.source = function (sentence) {
     return {
@@ -74,9 +85,9 @@ type: 'NMEA0183',
 
-  exports.transform = function(value, inputFormat, outputFormat) {
+  exports.transform = function (value, inputFormat, outputFormat) {
     value = exports.float(value);
 
-    inputFormat  = inputFormat.toLowerCase();
+    inputFormat = inputFormat.toLowerCase();
     outputFormat = outputFormat.toLowerCase();
 
-    if(inputFormat === outputFormat) {
+    if (inputFormat === outputFormat) {
       return value;
@@ -86,55 +97,55 @@ }
     // KM
-    if(inputFormat == 'km') {
-      if(outputFormat == 'nm') return value / utils.RATIOS.NM_IN_KM;
+    if (inputFormat == 'km') {
+      if (outputFormat == 'nm') return value / utils.RATIOS.NM_IN_KM;
     }
 
     // NM
-    if(inputFormat == 'nm') {
-      if(outputFormat == 'km') return value / utils.RATIOS.KM_IN_NM;
-      if(outputFormat == 'm') return value * 1000 / utils.RATIOS.KM_IN_NM ;
+    if (inputFormat == 'nm') {
+      if (outputFormat == 'km') return value / utils.RATIOS.KM_IN_NM;
+      if (outputFormat == 'm') return value * 1000 / utils.RATIOS.KM_IN_NM;
     }
-    
+
     // KNOTS
-    if(inputFormat == 'knots') {
-      if(outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_KNOTS;
-      if(outputFormat == 'ms') return value / utils.RATIOS.MS_IN_KNOTS;
-      if(outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_KNOTS;
+    if (inputFormat == 'knots') {
+      if (outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_KNOTS;
+      if (outputFormat == 'ms') return value / utils.RATIOS.MS_IN_KNOTS;
+      if (outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_KNOTS;
     }
 
     // KPH
-    if(inputFormat == 'kph') {
-      if(outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_KPH;
-      if(outputFormat == 'ms') return value / utils.RATIOS.MS_IN_KPH;
-      if(outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_KPH;
+    if (inputFormat == 'kph') {
+      if (outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_KPH;
+      if (outputFormat == 'ms') return value / utils.RATIOS.MS_IN_KPH;
+      if (outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_KPH;
     }
 
     // MPH
-    if(inputFormat == 'mph') {
-      if(outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_MPH;
-      if(outputFormat == 'ms') return value / utils.RATIOS.MS_IN_MPH;
-      if(outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_MPH;
+    if (inputFormat == 'mph') {
+      if (outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_MPH;
+      if (outputFormat == 'ms') return value / utils.RATIOS.MS_IN_MPH;
+      if (outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_MPH;
     }
 
     // MS
-    if(inputFormat == 'ms') {
-      if(outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_MS;
-      if(outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_MS;
-      if(outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_MS;
+    if (inputFormat == 'ms') {
+      if (outputFormat == 'knots') return value / utils.RATIOS.KNOTS_IN_MS;
+      if (outputFormat == 'mph') return value / utils.RATIOS.MPH_IN_MS;
+      if (outputFormat == 'kph') return value / utils.RATIOS.KPH_IN_MS;
     }
 
     // ANGLES
-    if(inputFormat == 'deg') {
-      if(outputFormat == 'rad') return value / utils.RATIOS.RAD_IN_DEG;
+    if (inputFormat == 'deg') {
+      if (outputFormat == 'rad') return value / utils.RATIOS.RAD_IN_DEG;
     }
 
-    if(inputFormat == 'rad') {
-      if(outputFormat == 'deg') return value / utils.RATIOS.DEG_IN_RAD;
+    if (inputFormat == 'rad') {
+      if (outputFormat == 'deg') return value / utils.RATIOS.DEG_IN_RAD;
     }
-    
-    if(inputFormat == 'c') {
-      if(outputFormat == 'k') return value + utils.RATIOS.CELCIUS_IN_KELVIN;
+
+    if (inputFormat == 'c') {
+      if (outputFormat == 'k') return value + utils.RATIOS.CELCIUS_IN_KELVIN;
     }
-    
-    if(inputFormat == 'k') {
-      if(outputFormat == 'c') return value - utils.RATIOS.CELCIUS_IN_KELVIN;
+
+    if (inputFormat == 'k') {
+      if (outputFormat == 'c') return value - utils.RATIOS.CELCIUS_IN_KELVIN;
     }
@@ -146,7 +157,7 @@
 
-  exports.magneticVariaton = function(degrees, pole) {
+  exports.magneticVariaton = function (degrees, pole) {
     pole = pole.toUpperCase();
     degrees = this.float(degrees);
 
-    if(pole == "S" || pole == "W") {
+    if (pole == "S" || pole == "W") {
       degrees *= -1;
@@ -158,7 +169,7 @@ }
 
-  exports.timestamp = function(time, date) {
+  exports.timestamp = function (time, date) {
     /* TIME (UTC) */
     var hours, minutes, seconds, year, month, day;
 
-    if(time) {
+    if (time) {
       hours = this.int(time.slice(0, 2), true);
@@ -175,3 +186,3 @@ minutes = this.int(time.slice(2, 4), true);
     /* DATE (UTC) */
-    if(date) {
+    if (date) {
       var year, month, day;
@@ -183,5 +194,5 @@ day = this.int(date.slice(0, 2), true);
       // HACK copied from jamesp/node-nmea
-      if(year < 73) {
+      if (year < 73) {
         year = this.int("20" + year);
-      } else { 
+      } else {
         year = this.int("19" + year);
@@ -201,3 +212,3 @@ }
 
-  exports.coordinate = function(value, pole) {
+  exports.coordinate = function (value, pole) {
     // N 5222.3277 should be read as 52°22.3277'
@@ -217,5 +228,5 @@ // E 454.5824 should be read as 4°54.5824'
 
-    var split   = value.split('.');
+    var split = value.split('.');
     var degrees = this.float(split[0].slice(0, -2));
-    var minsec  = this.float(split[0].slice(-2) + '.' + split[1]);
+    var minsec = this.float(split[0].slice(-2) + '.' + split[1]);
     var decimal = this.float(degrees + (minsec / 60));
@@ -226,8 +237,8 @@
     }
-    
+
     return exports.float(decimal);
   };
 
-  exports.zero = function(n) {
-    if(this.float(n) < 10) {
+  exports.zero = function (n) {
+    if (this.float(n) < 10) {
       return "0" + n;
@@ -239,4 +250,4 @@ } else {
 
-  exports.int = function(n) {
-    if(("" + n).trim() === '') {
+  exports.int = function (n) {
+    if (("" + n).trim() === '') {
       return 0;
@@ -248,8 +259,8 @@ } else {
 
-  exports.integer = function(n) {
+  exports.integer = function (n) {
     return exports.int(n);
   };
 
-  exports.float = function(n) {
-    if(("" + n).trim() === '') {
+  exports.float = function (n) {
+    if (("" + n).trim() === '') {
       return 0.0;
@@ -261,3 +272,3 @@ } else {
 
-  exports.double = function(n) {
+  exports.double = function (n) {
     return exports.float(n);
@@ -264,0 +275,0 @@ };

package.json

 {
   "name": "@signalk/nmea0183-utilities",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Various utilities for transforming NMEA0183 units into SI units for use in SK.",
@@ -24,2 +24,8 @@ "main": "index.js",
   "author": "Fabian Tollenaar <[e-mail]>",
+  "contributors": [
+    {
+      "name": "Marcel Verpaalen",
+      "email": "[e-mail]"
+    }
+  ],
   "license": "Apache-2.0",
@@ -26,0 +32,0 @@ "bugs": {

No alert changes

Improved metrics

Total package byte prevSize

17506

increased by16.64%

Number of package files

11

increased by10%

Lines of code

485

increased by12.53%

No dependency changes