socketcan - npm Package Compare versions

Comparing version 2.1.1 to 2.1.2

docs/api.js

@@ -6,3 +6,2 @@ YUI.add("yuidoc-meta", function(Y) {
         "Message",
-        "RawChannel",
         "Signal",
@@ -12,3 +11,2 @@ "exports"
     "modules": [
-        "CAN",
         "Signals"
@@ -18,7 +16,2 @@ ],
         {
-            "displayName": "CAN",
-            "name": "CAN",
-            "description": "Basic CAN access"
-        },
-        {
             "displayName": "Signals",
@@ -28,4 +21,5 @@ "name": "Signals",
         }
-    ]
+    ],
+    "elements": []
 } };
 });

docs/assets/js/api-filter.js

@@ -17,2 +17,6 @@ YUI.add('api-filter', function (Y) {
 
+        if (this.get('queryType') === 'elements') {
+            name = '<' + name + '>';
+        }
+
         return name;
@@ -28,3 +32,3 @@ }
 
-        // May be set to "classes" or "modules".
+        // May be set to "classes", "elements" or "modules".
         queryType: {
@@ -31,0 +35,0 @@ value: 'classes'

docs/assets/js/api-list.js

@@ -9,2 +9,3 @@ YUI.add('api-list', function (Y) {
     classesNode    = Y.one('#api-classes'),
+    elementsNode   = Y.one('#api-elements'),
     inputNode      = Y.one('#api-filter'),
@@ -101,3 +102,5 @@ modulesNode    = Y.one('#api-modules'),
 function getFilterResultNode() {
-    return filter.get('queryType') === 'classes' ? classesNode : modulesNode;
+    var queryType = filter.get('queryType');
+    return queryType === 'classes' ? classesNode
+            : queryType === 'elements' ? elementsNode : modulesNode;
 }
@@ -110,3 +113,3 @@
         typePlural   = filter.get('queryType'),
-        typeSingular = typePlural === 'classes' ? 'class' : 'module';
+        typeSingular = typePlural === 'classes' ? 'class' : typePlural === 'elements' ? 'element' : 'module';
 
@@ -187,2 +190,3 @@ if (e.results.length) {
     switch (name) {
+    case 'elements':// fallthru
     case 'classes': // fallthru
@@ -189,0 +193,0 @@ case 'modules':

docs/assets/js/apidocs.js

@@ -46,2 +46,8 @@ YUI().use(
 
+        // -- /elements/* -------------------------------------------------------
+        {
+            path     : '/elements/:element.html*',
+            callbacks: defaultRoute
+        },
+
         // -- /classes/* -------------------------------------------------------
@@ -171,3 +177,3 @@ {
 pjax.initRoot = function () {
-    var terminators = /^(?:classes|files|modules)$/,
+    var terminators = /^(?:classes|files|elements|modules)$/,
         parts       = pjax._getPathRoot().split('/'),
@@ -289,3 +295,3 @@ root        = [],
     // Handles success and local filesystem XHRs.
-    if (!status || (status >= 200 && status < 300)) {
+    if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
         pjax.initClassTabView();
@@ -301,3 +307,3 @@ }
     // Handles success and local filesystem XHRs.
-    if (!status || (status >= 200 && status < 300)) {
+    if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
         pjax.initLineNumbers();
@@ -304,0 +310,0 @@ }

docs/data.json

 {
     "project": {},
     "files": {
-        "src/raw.h": {
-            "name": "src/raw.h",
+        "socketcan.js": {
+            "name": "socketcan.js",
             "modules": {
-                "CAN": 1
-            },
-            "classes": {
-                "RawChannel": 1
-            },
-            "fors": {},
-            "namespaces": {}
-        },
-        "can.js": {
-            "name": "can.js",
-            "modules": {
                 "Signals": 1
@@ -34,20 +23,6 @@ },
     "modules": {
-        "CAN": {
-            "name": "CAN",
-            "submodules": {},
-            "classes": {
-                "RawChannel": 1
-            },
-            "fors": {
-                "exports": 1
-            },
-            "namespaces": {},
-            "tag": "module",
-            "file": "src/raw.h",
-            "line": 51,
-            "description": "Basic CAN access"
-        },
         "Signals": {
             "name": "Signals",
             "submodules": {},
+            "elements": {},
             "classes": {
@@ -66,4 +41,4 @@ "exports": 1,
             "tag": "module",
-            "file": "can.js",
-            "line": 163,
+            "file": "socketcan.js",
+            "line": 205,
             "description": "The Signals modules provides an interface to access the values/signals\nencoded in CAN messages."
@@ -73,16 +48,2 @@ }
     "classes": {
-        "RawChannel": {
-            "name": "RawChannel",
-            "shortname": "RawChannel",
-            "classitems": [],
-            "plugins": [],
-            "extensions": [],
-            "plugin_for": [],
-            "extension_for": [],
-            "module": "CAN",
-            "namespace": "",
-            "file": "src/raw.h",
-            "line": 51,
-            "description": "A Raw channel to access a certain CAN channel (e.g. vcan0) via CAN messages."
-        },
         "exports": {
@@ -96,4 +57,3 @@ "name": "exports",
             "extension_for": [],
-            "module": "Signals",
-            "namespace": ""
+            "module": "Signals"
         },
@@ -110,3 +70,3 @@ "Signal": {
             "namespace": "",
-            "file": "can.js",
+            "file": "socketcan.js",
             "line": 47,
@@ -125,4 +85,4 @@ "description": "The actual signal."
             "namespace": "",
-            "file": "can.js",
-            "line": 115,
+            "file": "socketcan.js",
+            "line": 136,
             "description": "Just a container to keep the Signals."
@@ -140,4 +100,4 @@ },
             "namespace": "",
-            "file": "can.js",
-            "line": 163,
+            "file": "socketcan.js",
+            "line": 205,
             "description": "A DatabaseService is usually generated once per bus to collect signals\ncoded in the CAN messages according a DB description.",
@@ -160,99 +120,6 @@ "is_constructor": 1,
     },
+    "elements": {},
     "classitems": [
         {
-            "file": "src/raw.h",
-            "line": 64,
-            "description": "Create a new CAN channel object",
-            "is_constructor": 1,
-            "params": [
-                {
-                    "name": "interface",
-                    "description": "interface name to create channel on (e.g. can0)",
-                    "type": "String"
-                }
-            ],
-            "return": {
-                "description": "new RawChannel object"
-            },
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "src/raw.h",
-            "line": 72,
-            "description": "Add listener to receive certain notifications",
-            "itemtype": "method",
-            "name": "addListener",
-            "params": [
-                {
-                    "name": "event",
-                    "description": "onMessage to register for incoming messages",
-                    "type": "String"
-                },
-                {
-                    "name": "callback",
-                    "description": "JS callback object",
-                    "type": "Any"
-                },
-                {
-                    "name": "instance",
-                    "description": "Optional instance pointer to call callback",
-                    "type": "Any"
-                }
-            ],
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "src/raw.h",
-            "line": 81,
-            "description": "Start operation on this CAN channel",
-            "itemtype": "method",
-            "name": "start",
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "src/raw.h",
-            "line": 87,
-            "description": "Stop any operations on this CAN channel",
-            "itemtype": "method",
-            "name": "stop",
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "src/raw.h",
-            "line": 93,
-            "description": "Send a CAN message immediately",
-            "itemtype": "method",
-            "name": "send",
-            "params": [
-                {
-                    "name": "message",
-                    "description": "JSON object describing the CAN message, keys are id, length, data {Buffer}, ext or rtr",
-                    "type": "Object"
-                }
-            ],
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "src/raw.h",
-            "line": 100,
-            "description": "Set a list of active filters to be applied for incoming messages",
-            "itemtype": "method",
-            "name": "setRxFilters",
-            "params": [
-                {
-                    "name": "filters",
-                    "description": "single filter or array of filter e.g. { id: 0x1ff, mask: 0x1ff, invert: false}, result of (id & mask)",
-                    "type": "Object"
-                }
-            ],
-            "class": "RawChannel",
-            "module": "CAN"
-        },
-        {
-            "file": "can.js",
+            "file": "socketcan.js",
             "line": 28,
@@ -272,7 +139,6 @@ "itemtype": "method",
             },
-            "class": "exports",
-            "module": "CAN"
+            "class": "exports"
         },
         {
-            "file": "can.js",
+            "file": "socketcan.js",
             "line": 53,
@@ -287,4 +153,18 @@ "description": "Symbolic name",
         {
-            "file": "can.js",
-            "line": 71,
+            "file": "socketcan.js",
+            "line": 74,
+            "description": "Label set for defined states of the signal.",
+            "class": "Signal",
+            "module": "Signals"
+        },
+        {
+            "file": "socketcan.js",
+            "line": 79,
+            "description": "this will allow triggering on mux'ed message ids.",
+            "class": "Signal",
+            "module": "Signals"
+        },
+        {
+            "file": "socketcan.js",
+            "line": 84,
             "description": "Current value",
@@ -298,4 +178,4 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 83,
+            "file": "socketcan.js",
+            "line": 97,
             "description": "Keep track of listeners who want to be notified if this signal changes",
@@ -314,4 +194,4 @@ "itemtype": "method",
         {
-            "file": "can.js",
-            "line": 93,
+            "file": "socketcan.js",
+            "line": 107,
             "description": "Set new value of this signal. Any local registered clients will\nreceive a notification. Please note, no CAN message is actually\nsend to the bus (@see DatabaseServer::send)",
@@ -331,4 +211,4 @@ "itemtype": "method",
         {
-            "file": "can.js",
-            "line": 121,
+            "file": "socketcan.js",
+            "line": 142,
             "description": "CAN identifier",
@@ -342,4 +222,4 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 128,
+            "file": "socketcan.js",
+            "line": 149,
             "description": "Extended Frame Format used",
@@ -353,4 +233,4 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 135,
+            "file": "socketcan.js",
+            "line": 156,
             "description": "Symbolic name",
@@ -364,7 +244,7 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 142,
+            "file": "socketcan.js",
+            "line": 163,
             "description": "Length in bytes of resulting CAN message",
             "itemtype": "attribute",
-            "name": "length",
+            "name": "len",
             "final": 1,
@@ -375,4 +255,24 @@ "class": "Message",
         {
-            "file": "can.js",
-            "line": 149,
+            "file": "socketcan.js",
+            "line": 171,
+            "description": "This is the time frame that the message gets generated",
+            "itemtype": "attribute",
+            "name": "interval",
+            "final": 1,
+            "class": "Message",
+            "module": "Signals"
+        },
+        {
+            "file": "socketcan.js",
+            "line": 179,
+            "description": "This is tells us the message is mutliplexed.",
+            "itemtype": "attribute",
+            "name": "muxed",
+            "final": 1,
+            "class": "Message",
+            "module": "Signals"
+        },
+        {
+            "file": "socketcan.js",
+            "line": 187,
             "description": "Named array of signals within this message. Accessible via index and name.",
@@ -387,4 +287,4 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 176,
+            "file": "socketcan.js",
+            "line": 218,
             "description": "Named array of known messages. Accessible via index and name.",
@@ -398,4 +298,4 @@ "itemtype": "attribute",
         {
-            "file": "can.js",
-            "line": 225,
+            "file": "socketcan.js",
+            "line": 282,
             "description": "Construct a CAN message and encode all related signals according\nthe rules. Finally send the message to the bus.",
@@ -414,4 +314,4 @@ "itemtype": "method",
         {
-            "file": "can.js",
-            "line": 269,
+            "file": "socketcan.js",
+            "line": 346,
             "itemtype": "method",
@@ -435,6 +335,10 @@ "name": "parseNetworkDescription",
         {
-            "message": "Missing item type\nCreate a new CAN channel object",
-            "line": " src/raw.h:64"
+            "message": "Missing item type\nLabel set for defined states of the signal.",
+            "line": " socketcan.js:74"
+        },
+        {
+            "message": "Missing item type\nthis will allow triggering on mux'ed message ids.",
+            "line": " socketcan.js:79"
         }
     ]
 }

package.json

@@ -8,3 +8,3 @@ {
   "description": "A SocketCAN abstraction layer for NodeJS.",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "license": "MIT",
@@ -11,0 +11,0 @@ "repository": {

tests/test-signal_conversion.js

@@ -6,23 +6,23 @@ var signals = require('../build/Release/can_signals');
 	data = new Buffer([0, 0, 0, 0, 0, 0, 0, 0]);
-
+	
 	signals.encode_signal(data, 0, 1, true, false, 1);
+console.log(data);
 	signals.encode_signal(data, 1, 1, true, false, 1);
+console.log(data);
 	signals.encode_signal(data, 2, 1, true, false, 0 /* set zero */);
+console.log(data);
 	signals.encode_signal(data, 3, 1, true, false, 1);
-	test.deepEqual(data, new Buffer([0x0b, 0x00, 0x00, 0, 0, 0, 0, 0]));
-
+console.log(data);
+	test.deepEqual(data, new Buffer([0x0B, 0x00, 0x00, 0, 0, 0, 0, 0]));
 	signals.encode_signal(data, 4, 8, true, false, 0xEA);
-console.log(data);
-	test.deepEqual(data, new Buffer([0x0B, 0x0E, 0xA0, 0, 0, 0, 0, 0]));
-
+	test.deepEqual(data, new Buffer([0xAB, 0x0E, 0x00, 0, 0, 0, 0, 0]));
+	
 	signals.encode_signal(data, 12, 12, true, false, 0xEDB);
-	test.deepEqual(data, new Buffer([0xDE, 0xAD, 0xBE, 0, 0, 0, 0, 0]));
+	test.deepEqual(data, new Buffer([0xAB, 0xBE, 0xED, 0, 0, 0, 0, 0]));
 
 	signals.encode_signal(data, 12, 12, true, false, 0);
-	test.deepEqual(data, new Buffer([0xDE, 0xA0, 0x00, 0, 0, 0, 0, 0]), "Overwriting signal value failed");
-
+	test.deepEqual(data, new Buffer([0xAB, 0x0E, 0x00, 0, 0, 0, 0, 0]), "Overwriting signal value failed");
 	test.done();
 }
 
-
 exports['little_endian_decode'] = function(test) {
@@ -32,14 +32,14 @@ data = new Buffer([0xDE, 0xAD, 0xBE, 0xEF, 0xCA, 0xFE, 0xBA, 0xBE]);
 	test.equals(signals.decode_signal(data, 0, 8, true, false), 0xDE);
-	test.equals(signals.decode_signal(data, 0, 12, true, false), 0xADE);
+	test.equals(signals.decode_signal(data, 0, 12, true, false), 0xDDE);
 	test.equals(signals.decode_signal(data, 0, 16, true, false), 0xADDE);
-
-	test.equals(signals.decode_signal(data, 12, 8, true, false), 0xDB);
-	test.equals(signals.decode_signal(data, 12, 12, true, false), 0xEDB);
-	test.equals(signals.decode_signal(data, 12, 20, true, false), 0xFEEDB);
-
-	test.equals(signals.decode_signal(data, 0, 1, true, false), 1);
+	
+	test.equals(signals.decode_signal(data, 12, 8, true, false), 0xEA);
+	test.equals(signals.decode_signal(data, 12, 12, true, false), 0xBEA);
+	test.equals(signals.decode_signal(data, 12, 20, true, false), 0xEFBEA);
+	
+	test.equals(signals.decode_signal(data, 0, 1, true, false), 0);
 	test.equals(signals.decode_signal(data, 1, 1, true, false), 1);
-	test.equals(signals.decode_signal(data, 2, 1, true, false), 0);
+	test.equals(signals.decode_signal(data, 2, 1, true, false), 1);
 	test.equals(signals.decode_signal(data, 3, 1, true, false), 1);
-
+	
 	test.done();
@@ -50,7 +50,7 @@ }
 	data = new Buffer([0xFE, 0xFF, 0x80]);
-
+	
 	test.equals(signals.decode_signal(data, 8, 8, true, true), -1);
 	test.equals(signals.decode_signal(data, 0, 16, true, true), -2);
 	test.equals(signals.decode_signal(data, 16, 8, true, true), -128);
-
+	
 	test.done();
@@ -61,12 +61,12 @@ }
 	data = new Buffer([0, 0, 0, 0, 0, 0, 0, 0]);
-
+	
 	signals.encode_signal(data, 0, 8, true, true, -1);
-	test.deepEqual(data, [0xFF, 0x00, 0x00, 0, 0, 0, 0, 0]);
-
+	test.deepEqual(data, new Buffer([0xFF, 0x00, 0x00, 0, 0, 0, 0, 0]));
+	
 	signals.encode_signal(data, 0, 16, true, true, -2);
-	test.deepEqual(data, [0xFE, 0xFF, 0x00, 0, 0, 0, 0, 0]);
-
+	test.deepEqual(data, new Buffer([0xFE, 0xFF, 0x00, 0, 0, 0, 0, 0]));
+	
 	signals.encode_signal(data, 16, 8, true, true, -128);
-	test.deepEqual(data, [0xFE, 0xFF, 0x80, 0, 0, 0, 0, 0]);
-
+	test.deepEqual(data, new Buffer([0xFE, 0xFF, 0x80, 0, 0, 0, 0, 0]));
+	
 	test.done();
@@ -77,3 +77,3 @@ }
 	data = new Buffer([0, 0, 0, 0, 0, 0, 0, 0]);
-
+	
 	signals.encode_signal(data, 0, 1, false, false, 1);
@@ -83,13 +83,13 @@ signals.encode_signal(data, 1, 1, false, false, 1);
 	signals.encode_signal(data, 3, 1, false, false, 1);
-	test.deepEqual(data, [0xD0, 0x00, 0x00, 0, 0, 0, 0, 0]);
+	test.deepEqual(data, new Buffer([0xD0, 0x00, 0x00, 0, 0, 0, 0, 0]));
+	
+	signals.encode_signal(data, 4, 8, false, false, 0xEA);
+	test.deepEqual(data, new Buffer([0xDE, 0xA0, 0x00, 0, 0, 0, 0, 0]));
+	
+	signals.encode_signal(data, 12, 12, false, false, 0xDBE);
+	test.deepEqual(data, new Buffer([0xDE, 0xAD, 0xBE, 0, 0, 0, 0, 0]));
 
-	signals.encode_signal(data, 11, 8, false, false, 0xEA);
-	test.deepEqual(data, [0xDE, 0xA0, 0x00, 0, 0, 0, 0, 0]);
-
-	signals.encode_signal(data, 23, 12, false, false, 0xDBE);
-	test.deepEqual(data, [0xDE, 0xAD, 0xBE, 0, 0, 0, 0, 0]);
-
-	signals.encode_signal(data, 23, 12, false, false, 0);
-	test.deepEqual(data, [0xDE, 0xA0, 0x00, 0, 0, 0, 0, 0], "Overwriting signal value failed");
-
+	signals.encode_signal(data, 12, 12, false, false, 0);
+	test.deepEqual(data, new Buffer([0xDE, 0xA0, 0x00, 0, 0, 0, 0, 0]), "Overwriting signal value failed");
+	
 	test.done();
@@ -101,5 +101,8 @@ }
 
-	test.equals(signals.decode_signal(data, 7, 8, false, false), 0xDE);
-	test.equals(signals.decode_signal(data, 15, 16, false, false), 0xDEAD);
+	test.equals(signals.decode_signal(data, 0, 8, false, false), 0xDE);
+	test.equals(signals.decode_signal(data, 0, 16, false, false), 0xDEAD);
 
+	test.equals(signals.decode_signal(data, 7, 8, false, false), 0x56);
+	test.equals(signals.decode_signal(data, 15, 16, false, false), 0xDF77);
+	
 	test.equals(signals.decode_signal(data, 0, 1, false, false), 1);
@@ -109,3 +112,3 @@ test.equals(signals.decode_signal(data, 1, 1, false, false), 1);
 	test.equals(signals.decode_signal(data, 3, 1, false, false), 1);
-
+	
 	test.done();
@@ -116,12 +119,12 @@ }
 	data = new Buffer([0, 0, 0, 0, 0, 0, 0, 0]);
-
-	signals.encode_signal(data, 7, 8, false, true, -1);
-	test.deepEqual(data, [0xFF, 0x00, 0x00, 0, 0, 0, 0, 0]);
-
-	signals.encode_signal(data, 15, 16, false, true, -2);
-	test.deepEqual(data, [0xFF, 0xFE, 0x00, 0, 0, 0, 0, 0]);
-
-	signals.encode_signal(data, 23, 8, false, true, -128);
-	test.deepEqual(data, [0xFF, 0xFE, 0x80, 0, 0, 0, 0, 0]);
-
+	
+	signals.encode_signal(data, 0, 8, false, true, -1);
+	test.deepEqual(data, new Buffer([0xFF, 0x00, 0x00, 0, 0, 0, 0, 0]));
+	
+	signals.encode_signal(data, 0, 16, false, true, -2);
+	test.deepEqual(data, new Buffer([0xFF, 0xFE, 0x00, 0, 0, 0, 0, 0]));
+	
+	signals.encode_signal(data, 16, 8, false, true, -128);
+	test.deepEqual(data, new Buffer([0xFF, 0xFE, 0x80, 0, 0, 0, 0, 0]));
+	
 	test.done();
@@ -132,9 +135,9 @@ }
 	data = new Buffer([0xFF, 0xFE, 0x80 ]);
-
-	test.equals(signals.decode_signal(data, 7, 8, false, true), -1);
-	test.equals(signals.decode_signal(data, 15, 16, false, true), -2);
-	test.equals(signals.decode_signal(data, 23, 8, false, true), -128);
-
+	
+	test.equals(signals.decode_signal(data, 0, 8, false, true), -1);
+	test.equals(signals.decode_signal(data, 0, 16, false, true), -2);
+	test.equals(signals.decode_signal(data, 16, 8, false, true), -128);
+	
 	test.done();
 }
 

No alert changes

Worsened metrics

Total package byte prevSize

240624

decreased by-6.93%

Number of package files

47

decreased by-4.08%

Lines of code

2332

decreased by-3.48%

No dependency changes