add day of week in DPT10

Author: ekarak

Diff for: README-datapoints.md

@@ -11,8 +11,8 @@
 |DPT7   	| 16-bit unsigned int  | Numeric  |   	|  0..65535 	|
 |DPT8   	| 16-bit signed integer | Numeric |   	|  -32768..32767 |
 |DPT9   	| 16-bit floating point | Numeric |   	|   	|
-|DPT10   	| 24-bit time 	|   Date	|  new Date() |   only the time part is used |
-|DPT11   	| 24-bit date 	|   Date	|  new Date() |   only the date part is used |
+|DPT10   	| 24-bit time + day of week 	|   Date	|  new Date() |   only the time part is used, see note |
+|DPT11   	| 24-bit date 	|   Date	|  new Date() |   only the date part is used, see note |
 |DPT12   	| 32-bit unsigned int | Numeric |   	|   	|
 |DPT13   	| 32-bit signed int   | Numeric |   	|   	|
 |DPT14   	| 32-bit floating point | Numeric |   	|  incomplete: subtypes |
@@ -54,3 +54,9 @@ commontest.do('DPT5.003', [
   { apdu_data:  [0xff], jsval: 360 }
 ]);
 ```
+
+## Date and time DPTs (DPT10, DPT11)
+Please have in mind that Javascript and KNX have very different base type for time and date.
+
+- DPT10 is time (hh:mm:ss) plus "day of week". This concept is unavailable in JS, so you'll be getting/setting a regular *Date* Js object, but  *please remember* you'll need to _ignore_ the date, month and year. The *exact same datagram* that converts to "Mon, Jul 1st 12:34:56", will evaluate to a wildly different JS Date of "Mon, Jul 8th 12:34:56" one week later. Be warned!
+- DPT11 is date (dd/mm/yyyy): the same applies for DPT11, you'll need to *ignore the time part*.

Diff for: src/dptlib/dpt10.js

@@ -16,14 +16,17 @@ var timeRegexp = /(\d{1,2}):(\d{1,2}):(\d{1,2})/;
 
 exports.formatAPDU = function(value) {
   var apdu_data = new Buffer(3);
+  var dow, hour, minute, second;
+  // day of week. NOTE: JS Sunday = 0
   switch(typeof value) {
     case 'string':
       // try to parse
       match = timeRegexp.exec(value);
       if (match) {
-        apdu_data[0] = parseInt(match[1]);
-        apdu_data[1] = parseInt(match[2]);
-        apdu_data[2] = parseInt(match[3]);
+        dow = ((new Date().getDay()-7) % 7)+7;
+        hour = parseInt(match[1]);
+        minute = parseInt(match[2]);
+        second = parseInt(match[3]);
       } else {
         log.warn("DPT10: invalid time format (%s)", value);
       }
@@ -36,10 +39,14 @@ exports.formatAPDU = function(value) {
     case 'number':
       value = new Date(value);
     default:
-      apdu_data[0] = value.getHours();
-      apdu_data[1] = value.getMinutes();
-      apdu_data[2] = value.getSeconds();
+      dow = ((value.getDay()-7) % 7)+7;
+      hour = value.getHours();
+      minute = value.getMinutes();
+      second = value.getSeconds();
   }
+  apdu_data[0] = (dow<<5) + hour;
+  apdu_data[1] = minute;
+  apdu_data[2] = second;
   return apdu_data;
 }
 
@@ -56,7 +63,9 @@ exports.fromBuffer = function(buf) {
     if (hours >= 0 & hours <= 23 &
       minutes >= 0 & minutes <= 59 &
       seconds >= 0 & seconds <= 59) {
-      return util.format("%d:%d:%d", hours, minutes, seconds);
+      d.setHours(hours);
+      d.setMinutes(minutes);
+      d.setSeconds(seconds);
     } else {
       log.warn(
         "DPT10: buffer %j (decoded as %d:%d:%d) is not a valid time",

Diff for: test/dptlib/test-dpt10.js

@@ -8,43 +8,46 @@ const DPTLib = require('../../src/dptlib');
 const assert = require('assert');
 
 function timecompare(date1, sign, date2) {
+  var dow1 = date1.getDay();
   var hour1 = date1.getHours();
   var min1 = date1.getMinutes();
   var sec1 = date1.getSeconds();
+  var dow2 = date2.getDay();
   var hour2 = date2.getHours();
   var min2 = date2.getMinutes();
   var sec2 = date2.getSeconds();
   if (sign === '===') {
-    if (hour1 === hour2 && min1 === min2 && sec1 === sec2) return true;
+    if (dow1 == dow2 && hour1 === hour2 && min1 === min2 && sec1 === sec2) return true;
     else return false;
   } else if (sign === '>') {
-    if (hour1 > hour2) return true;
-    else if (hour1 === hour2 && min1 > min2) return true;
-    else if (hour1 === hour2 && min1 === min2 && sec1 > sec2) return true;
+    if (dow1 > dow2) return true;
+    else if (dow1 == dow2 && hour1 > hour2) return true;
+    else if (dow1 == dow2 && hour1 === hour2 && min1 > min2) return true;
+    else if (dow1 == dow2 && hour1 === hour2 && min1 === min2 && sec1 > sec2) return true;
     else return false;
   }
 }
 
 test('DPT10 time conversion', function(t) {
+  var testdate = new Date('July 1, 2019 23:15:30'); // Monday
   var tests = [
-    ['DPT10', [12, 23, 34], '12:23:34'],
-    ['DPT10', [15, 45, 56], '15:45:56']
-  ]
+    ['DPT10', [32+23, 15, 30], testdate]
+  ];
   for (var i = 0; i < tests.length; i++) {
     var dpt = DPTLib.resolve(tests[i][0]);
     var buf = new Buffer(tests[i][1]);
     var val = tests[i][2];
 
     // unmarshalling test (raw data to value)
     var converted = DPTLib.fromBuffer(buf, dpt);
-    t.ok(converted == val,
-      `${tests[i][0]} fromBuffer value ${val} => ${converted}`);
+    t.ok(timecompare(converted, '===', val) ,
+      `${tests[i][0]} fromBuffer value ${buf.toString('hex')} => expected ${val}, got ${converted}`);
 
     // marshalling test (value to raw data)
     var apdu = {};
     DPTLib.populateAPDU(val, apdu, 'dpt10');
     t.ok(Buffer.compare(buf, apdu.data) == 0,
-      `${tests[i][0]} formatAPDU value ${val} => ${converted}`);
+      `${tests[i][0]} formatAPDU value ${val} => expected ${buf.toString('hex')}, got ${apdu.data.toString('hex')}`);
   }
   t.end()
 })