Fix bug with constructing SBP messages with fields in javascript. Augment all tests with constructMsg test. Add settings example.

Author: JoshuaGross

RELEASE_NOTES.md

@@ -6,12 +6,17 @@ For a detailed index of changes, please see the
 
 Contents
 --------
+ * [v1.1.1](#v1.1.1)
  * [v1.1.0](#v1.1.0)
  * [v1.0.2](#v1.0.2)
  * [v1.0.1](#v1.0.1)
  * [v0.39](#v0.39)
  * [v0.33](#v0.33)
 
+v1.1.1 <a name="v1.1.1"></a>
+--------------------------
+* Javascript: fixed bug with `constructMsg` and added more tests and examples for message construction.
+
 v1.1.0 <a name="v1.1.0"></a>
 --------------------------
 * Added `MSG_SETTINGS_REGISTER` message

docs/sbp.pdf

@@ -46,6 +46,7 @@ var ((( m.identifier | js_classnameify ))) = function (sbp, fields) {
   return this;
 };
 ((( m.identifier | js_classnameify ))).prototype = Object.create(SBP.prototype);
+((( m.identifier | js_classnameify ))).prototype.messageType = "(((m.identifier)))";
 ((*- if m.sbp_id *))
 ((( m.identifier | js_classnameify ))).prototype.msg_type = ((('0x%04X'|format(m.sbp_id))));
 ((*- endif *))

generator/sbpg/targets/resources/sbp_js.js.j2

@@ -1,5 +1,5 @@
 name:                  sbp
-version:               1.1.0
+version:               1.1.1
 synopsis:              SwiftNav's SBP Library
 homepage:              https://github.com/swift-nav/libsbp
 license:               LGPL-3

haskell/sbp.cabal

@@ -47,6 +47,7 @@ var MsgAcqResult = function (sbp, fields) {
   return this;
 };
 MsgAcqResult.prototype = Object.create(SBP.prototype);
+MsgAcqResult.prototype.messageType = "MSG_ACQ_RESULT";
 MsgAcqResult.prototype.msg_type = 0x0014;
 MsgAcqResult.prototype.constructor = MsgAcqResult;
 MsgAcqResult.prototype.parser = new Parser()
@@ -83,6 +84,7 @@ var MsgAcqResultDepA = function (sbp, fields) {
   return this;
 };
 MsgAcqResultDepA.prototype = Object.create(SBP.prototype);
+MsgAcqResultDepA.prototype.messageType = "MSG_ACQ_RESULT_DEP_A";
 MsgAcqResultDepA.prototype.msg_type = 0x0015;
 MsgAcqResultDepA.prototype.constructor = MsgAcqResultDepA;
 MsgAcqResultDepA.prototype.parser = new Parser()

javascript/sbp/acquisition.js

@@ -40,6 +40,7 @@ var MsgBootloaderHandshakeReq = function (sbp, fields) {
   return this;
 };
 MsgBootloaderHandshakeReq.prototype = Object.create(SBP.prototype);
+MsgBootloaderHandshakeReq.prototype.messageType = "MSG_BOOTLOADER_HANDSHAKE_REQ";
 MsgBootloaderHandshakeReq.prototype.msg_type = 0x00B3;
 MsgBootloaderHandshakeReq.prototype.constructor = MsgBootloaderHandshakeReq;
 MsgBootloaderHandshakeReq.prototype.parser = new Parser()
@@ -68,6 +69,7 @@ var MsgBootloaderHandshakeResp = function (sbp, fields) {
   return this;
 };
 MsgBootloaderHandshakeResp.prototype = Object.create(SBP.prototype);
+MsgBootloaderHandshakeResp.prototype.messageType = "MSG_BOOTLOADER_HANDSHAKE_RESP";
 MsgBootloaderHandshakeResp.prototype.msg_type = 0x00B4;
 MsgBootloaderHandshakeResp.prototype.constructor = MsgBootloaderHandshakeResp;
 MsgBootloaderHandshakeResp.prototype.parser = new Parser()
@@ -96,6 +98,7 @@ var MsgBootloaderJumpToApp = function (sbp, fields) {
   return this;
 };
 MsgBootloaderJumpToApp.prototype = Object.create(SBP.prototype);
+MsgBootloaderJumpToApp.prototype.messageType = "MSG_BOOTLOADER_JUMP_TO_APP";
 MsgBootloaderJumpToApp.prototype.msg_type = 0x00B1;
 MsgBootloaderJumpToApp.prototype.constructor = MsgBootloaderJumpToApp;
 MsgBootloaderJumpToApp.prototype.parser = new Parser()
@@ -123,6 +126,7 @@ var MsgNapDeviceDnaReq = function (sbp, fields) {
   return this;
 };
 MsgNapDeviceDnaReq.prototype = Object.create(SBP.prototype);
+MsgNapDeviceDnaReq.prototype.messageType = "MSG_NAP_DEVICE_DNA_REQ";
 MsgNapDeviceDnaReq.prototype.msg_type = 0x00DE;
 MsgNapDeviceDnaReq.prototype.constructor = MsgNapDeviceDnaReq;
 MsgNapDeviceDnaReq.prototype.parser = new Parser()
@@ -151,6 +155,7 @@ var MsgNapDeviceDnaResp = function (sbp, fields) {
   return this;
 };
 MsgNapDeviceDnaResp.prototype = Object.create(SBP.prototype);
+MsgNapDeviceDnaResp.prototype.messageType = "MSG_NAP_DEVICE_DNA_RESP";
 MsgNapDeviceDnaResp.prototype.msg_type = 0x00DD;
 MsgNapDeviceDnaResp.prototype.constructor = MsgNapDeviceDnaResp;
 MsgNapDeviceDnaResp.prototype.parser = new Parser()
@@ -177,6 +182,7 @@ var MsgBootloaderHandshakeDepA = function (sbp, fields) {
   return this;
 };
 MsgBootloaderHandshakeDepA.prototype = Object.create(SBP.prototype);
+MsgBootloaderHandshakeDepA.prototype.messageType = "MSG_BOOTLOADER_HANDSHAKE_DEP_A";
 MsgBootloaderHandshakeDepA.prototype.msg_type = 0x00B0;
 MsgBootloaderHandshakeDepA.prototype.constructor = MsgBootloaderHandshakeDepA;
 MsgBootloaderHandshakeDepA.prototype.parser = new Parser()

javascript/sbp/bootload.js

@@ -22,7 +22,7 @@ var crc = sbp.crc16;
  * @param MsgType {Function} The message type you want to construct.
  * @param fields {Object} Optional key-value pairs of message fields.
  */
-module.exports = function constructMsg (MsgType, fields) {
+module.exports = function constructMsg (MsgType, fields, sender) {
   if (typeof MsgType !== 'function') {
     throw new Error('The MsgType parameter must be a valid SBP message type constructor.');
   }
@@ -43,12 +43,12 @@ module.exports = function constructMsg (MsgType, fields) {
   // Construct message envelope
   msgEnvelope.preamble = sbp.preambleByte;
   msgEnvelope.msg_type = MsgType.prototype.msg_type;
-  msgEnvelope.sender = 0; // see SBP.pdf documentation
+  msgEnvelope.sender = sender || 0; // see SBP.pdf documentation
   msgEnvelope.length = msgEnvelope.payload.length;
   msgEnvelope.crc = crc(msgEnvelope.payload,
                       crc(msgEnvelope.getLengthBuffer(),
                         crc(msgEnvelope.getSenderBuffer(),
                           crc(msgEnvelope.getMsgTypeBuffer()))));
 
-  return msgEnvelope;
+  return msg;
 };

javascript/sbp/construct.js

@@ -45,6 +45,7 @@ var MsgExtEvent = function (sbp, fields) {
   return this;
 };
 MsgExtEvent.prototype = Object.create(SBP.prototype);
+MsgExtEvent.prototype.messageType = "MSG_EXT_EVENT";
 MsgExtEvent.prototype.msg_type = 0x0101;
 MsgExtEvent.prototype.constructor = MsgExtEvent;
 MsgExtEvent.prototype.parser = new Parser()

javascript/sbp/ext_events.js

@@ -53,6 +53,7 @@ var MsgFileioReadReq = function (sbp, fields) {
   return this;
 };
 MsgFileioReadReq.prototype = Object.create(SBP.prototype);
+MsgFileioReadReq.prototype.messageType = "MSG_FILEIO_READ_REQ";
 MsgFileioReadReq.prototype.msg_type = 0x00A8;
 MsgFileioReadReq.prototype.constructor = MsgFileioReadReq;
 MsgFileioReadReq.prototype.parser = new Parser()
@@ -89,6 +90,7 @@ var MsgFileioReadResp = function (sbp, fields) {
   return this;
 };
 MsgFileioReadResp.prototype = Object.create(SBP.prototype);
+MsgFileioReadResp.prototype.messageType = "MSG_FILEIO_READ_RESP";
 MsgFileioReadResp.prototype.msg_type = 0x00A3;
 MsgFileioReadResp.prototype.constructor = MsgFileioReadResp;
 MsgFileioReadResp.prototype.parser = new Parser()
@@ -126,6 +128,7 @@ var MsgFileioReadDirReq = function (sbp, fields) {
   return this;
 };
 MsgFileioReadDirReq.prototype = Object.create(SBP.prototype);
+MsgFileioReadDirReq.prototype.messageType = "MSG_FILEIO_READ_DIR_REQ";
 MsgFileioReadDirReq.prototype.msg_type = 0x00A9;
 MsgFileioReadDirReq.prototype.constructor = MsgFileioReadDirReq;
 MsgFileioReadDirReq.prototype.parser = new Parser()
@@ -161,6 +164,7 @@ var MsgFileioReadDirResp = function (sbp, fields) {
   return this;
 };
 MsgFileioReadDirResp.prototype = Object.create(SBP.prototype);
+MsgFileioReadDirResp.prototype.messageType = "MSG_FILEIO_READ_DIR_RESP";
 MsgFileioReadDirResp.prototype.msg_type = 0x00AA;
 MsgFileioReadDirResp.prototype.constructor = MsgFileioReadDirResp;
 MsgFileioReadDirResp.prototype.parser = new Parser()
@@ -192,6 +196,7 @@ var MsgFileioRemove = function (sbp, fields) {
   return this;
 };
 MsgFileioRemove.prototype = Object.create(SBP.prototype);
+MsgFileioRemove.prototype.messageType = "MSG_FILEIO_REMOVE";
 MsgFileioRemove.prototype.msg_type = 0x00AC;
 MsgFileioRemove.prototype.constructor = MsgFileioRemove;
 MsgFileioRemove.prototype.parser = new Parser()
@@ -226,6 +231,7 @@ var MsgFileioWriteReq = function (sbp, fields) {
   return this;
 };
 MsgFileioWriteReq.prototype = Object.create(SBP.prototype);
+MsgFileioWriteReq.prototype.messageType = "MSG_FILEIO_WRITE_REQ";
 MsgFileioWriteReq.prototype.msg_type = 0x00AD;
 MsgFileioWriteReq.prototype.constructor = MsgFileioWriteReq;
 MsgFileioWriteReq.prototype.parser = new Parser()
@@ -261,6 +267,7 @@ var MsgFileioWriteResp = function (sbp, fields) {
   return this;
 };
 MsgFileioWriteResp.prototype = Object.create(SBP.prototype);
+MsgFileioWriteResp.prototype.messageType = "MSG_FILEIO_WRITE_RESP";
 MsgFileioWriteResp.prototype.msg_type = 0x00AB;
 MsgFileioWriteResp.prototype.constructor = MsgFileioWriteResp;
 MsgFileioWriteResp.prototype.parser = new Parser()

javascript/sbp/file_io.js

@@ -48,6 +48,7 @@ var MsgFlashProgram = function (sbp, fields) {
   return this;
 };
 MsgFlashProgram.prototype = Object.create(SBP.prototype);
+MsgFlashProgram.prototype.messageType = "MSG_FLASH_PROGRAM";
 MsgFlashProgram.prototype.msg_type = 0x00E6;
 MsgFlashProgram.prototype.constructor = MsgFlashProgram;
 MsgFlashProgram.prototype.parser = new Parser()
@@ -82,6 +83,7 @@ var MsgFlashDone = function (sbp, fields) {
   return this;
 };
 MsgFlashDone.prototype = Object.create(SBP.prototype);
+MsgFlashDone.prototype.messageType = "MSG_FLASH_DONE";
 MsgFlashDone.prototype.msg_type = 0x00E0;
 MsgFlashDone.prototype.constructor = MsgFlashDone;
 MsgFlashDone.prototype.parser = new Parser()
@@ -114,6 +116,7 @@ var MsgFlashReadReq = function (sbp, fields) {
   return this;
 };
 MsgFlashReadReq.prototype = Object.create(SBP.prototype);
+MsgFlashReadReq.prototype.messageType = "MSG_FLASH_READ_REQ";
 MsgFlashReadReq.prototype.msg_type = 0x00E7;
 MsgFlashReadReq.prototype.constructor = MsgFlashReadReq;
 MsgFlashReadReq.prototype.parser = new Parser()
@@ -150,6 +153,7 @@ var MsgFlashReadResp = function (sbp, fields) {
   return this;
 };
 MsgFlashReadResp.prototype = Object.create(SBP.prototype);
+MsgFlashReadResp.prototype.messageType = "MSG_FLASH_READ_RESP";
 MsgFlashReadResp.prototype.msg_type = 0x00E1;
 MsgFlashReadResp.prototype.constructor = MsgFlashReadResp;
 MsgFlashReadResp.prototype.parser = new Parser()
@@ -184,6 +188,7 @@ var MsgFlashErase = function (sbp, fields) {
   return this;
 };
 MsgFlashErase.prototype = Object.create(SBP.prototype);
+MsgFlashErase.prototype.messageType = "MSG_FLASH_ERASE";
 MsgFlashErase.prototype.msg_type = 0x00E2;
 MsgFlashErase.prototype.constructor = MsgFlashErase;
 MsgFlashErase.prototype.parser = new Parser()
@@ -213,6 +218,7 @@ var MsgStmFlashLockSector = function (sbp, fields) {
   return this;
 };
 MsgStmFlashLockSector.prototype = Object.create(SBP.prototype);
+MsgStmFlashLockSector.prototype.messageType = "MSG_STM_FLASH_LOCK_SECTOR";
 MsgStmFlashLockSector.prototype.msg_type = 0x00E3;
 MsgStmFlashLockSector.prototype.constructor = MsgStmFlashLockSector;
 MsgStmFlashLockSector.prototype.parser = new Parser()
@@ -240,6 +246,7 @@ var MsgStmFlashUnlockSector = function (sbp, fields) {
   return this;
 };
 MsgStmFlashUnlockSector.prototype = Object.create(SBP.prototype);
+MsgStmFlashUnlockSector.prototype.messageType = "MSG_STM_FLASH_UNLOCK_SECTOR";
 MsgStmFlashUnlockSector.prototype.msg_type = 0x00E4;
 MsgStmFlashUnlockSector.prototype.constructor = MsgStmFlashUnlockSector;
 MsgStmFlashUnlockSector.prototype.parser = new Parser()
@@ -265,6 +272,7 @@ var MsgStmUniqueIdReq = function (sbp, fields) {
   return this;
 };
 MsgStmUniqueIdReq.prototype = Object.create(SBP.prototype);
+MsgStmUniqueIdReq.prototype.messageType = "MSG_STM_UNIQUE_ID_REQ";
 MsgStmUniqueIdReq.prototype.msg_type = 0x00E8;
 MsgStmUniqueIdReq.prototype.constructor = MsgStmUniqueIdReq;
 MsgStmUniqueIdReq.prototype.parser = new Parser()
@@ -291,6 +299,7 @@ var MsgStmUniqueIdResp = function (sbp, fields) {
   return this;
 };
 MsgStmUniqueIdResp.prototype = Object.create(SBP.prototype);
+MsgStmUniqueIdResp.prototype.messageType = "MSG_STM_UNIQUE_ID_RESP";
 MsgStmUniqueIdResp.prototype.msg_type = 0x00E5;
 MsgStmUniqueIdResp.prototype.constructor = MsgStmUniqueIdResp;
 MsgStmUniqueIdResp.prototype.parser = new Parser()
@@ -318,6 +327,7 @@ var MsgM25FlashWriteStatus = function (sbp, fields) {
   return this;
 };
 MsgM25FlashWriteStatus.prototype = Object.create(SBP.prototype);
+MsgM25FlashWriteStatus.prototype.messageType = "MSG_M25_FLASH_WRITE_STATUS";
 MsgM25FlashWriteStatus.prototype.msg_type = 0x00F3;
 MsgM25FlashWriteStatus.prototype.constructor = MsgM25FlashWriteStatus;
 MsgM25FlashWriteStatus.prototype.parser = new Parser()

javascript/sbp/flash.js

@@ -41,6 +41,7 @@ var GnssSignal = function (sbp, fields) {
   return this;
 };
 GnssSignal.prototype = Object.create(SBP.prototype);
+GnssSignal.prototype.messageType = "GnssSignal";
 GnssSignal.prototype.constructor = GnssSignal;
 GnssSignal.prototype.parser = new Parser()
   .endianess('little')

javascript/sbp/gnss_signal.js

@@ -42,6 +42,7 @@ var MsgLog = function (sbp, fields) {
   return this;
 };
 MsgLog.prototype = Object.create(SBP.prototype);
+MsgLog.prototype.messageType = "MSG_LOG";
 MsgLog.prototype.msg_type = 0x0401;
 MsgLog.prototype.constructor = MsgLog;
 MsgLog.prototype.parser = new Parser()
@@ -70,6 +71,7 @@ var MsgTweet = function (sbp, fields) {
   return this;
 };
 MsgTweet.prototype = Object.create(SBP.prototype);
+MsgTweet.prototype.messageType = "MSG_TWEET";
 MsgTweet.prototype.msg_type = 0x0012;
 MsgTweet.prototype.constructor = MsgTweet;
 MsgTweet.prototype.parser = new Parser()
@@ -96,6 +98,7 @@ var MsgPrintDep = function (sbp, fields) {
   return this;
 };
 MsgPrintDep.prototype = Object.create(SBP.prototype);
+MsgPrintDep.prototype.messageType = "MSG_PRINT_DEP";
 MsgPrintDep.prototype.msg_type = 0x0010;
 MsgPrintDep.prototype.constructor = MsgPrintDep;
 MsgPrintDep.prototype.parser = new Parser()

javascript/sbp/logging.js

@@ -94,7 +94,7 @@ var sbpImports = {
   tracking: require('./tracking.js')
 };
 
-var sbpTable = Object.keys(sbpImports).reduce(function (prev, key) {
+var sbpIdTable = Object.keys(sbpImports).reduce(function (prev, key) {
   var curr = sbpImports[key];
   var numericKeysDict = {};
   Object.keys(curr).map(function (key) {
@@ -105,6 +105,18 @@ var sbpTable = Object.keys(sbpImports).reduce(function (prev, key) {
   return mergeDict(prev, numericKeysDict);
 }, {});
 
+var sbpMessageTypesTable = Object.keys(sbpImports).reduce(function (prev, key) {
+  var curr = sbpImports[key];
+  var nonNumericKeysDict = {};
+  Object.keys(curr).map(function (key) {
+    if (parseInt(key) != key) {
+      var messageType = curr[key].prototype.messageType || key;
+      nonNumericKeysDict[messageType] = curr[key];
+    }
+  });
+  return mergeDict(prev, nonNumericKeysDict);
+}, {});
+
 var parser = new Parser()
   .endianess('little')
   .uint8('preamble')
@@ -134,9 +146,12 @@ module.exports = {
   preambleByte: SBP_PREAMBLE,
   crc16: crc16,
 
+  sbpIdTable: sbpIdTable,
+  sbpMessageTypesTable: sbpMessageTypesTable,
+
   decode: function decode (msg) {
     var sbp = parser.parse(msg);
-    var msgTypeDecoder = sbpTable[sbp['msg_type']];
+    var msgTypeDecoder = sbpIdTable[sbp['msg_type']];
 
     if (typeof msgTypeDecoder === 'undefined') {
       console.log("Unknown message type: ", sbp['msg_type']);