Merge pull request #378 from mfine/mfine/libsbp/time

Move from timestamp to time

Author: mfine

java/src/com/swiftnav/sbp/loggers/JSONLogger.java

@@ -47,7 +47,7 @@ private String ISOTimestamp() {
     public void sendMessage(SBPMessage msg) throws IOException {
         JSONObject logobj = new JSONObject();
         try {
-            logobj.put("timestamp", ISOTimestamp());
+            logobj.put("time", ISOTimestamp());
             logobj.put("data", msg.toJSON());
         } catch (JSONException e) {
             e.printStackTrace();

python/data/serial_link_log_20150310-115522-test.log.dat

@@ -1 +1 @@
-{"timestamp": 1430236173, "data": {"sender": 1226, "msg_type": 16, "crc": 48120, "length": 26, "preamble": 85, "payload": "SU5GTzogTmV3IHRydXN0ZWQgZXBoZW1lcmk="}, "delta": 123742}
+{"data": {"sender": 1226, "msg_type": 16, "crc": 48120, "length": 26, "preamble": 85, "payload": "SU5GTzogTmV3IHRydXN0ZWQgZXBoZW1lcmk="}, "time": "2016-09-12T20:19:31.724958"}

python/data/serial_link_log_20150423-154336_test.log.dat

@@ -47,7 +47,7 @@ def breakiter(self):
     """
     self._broken = True
 
-  def _timestamp(self):
+  def _time(self):
     """
     Timestamp generator.
 
@@ -66,7 +66,7 @@ def next(self):
           raise StopIteration
       except IOError:
         raise StopIteration
-    return (msg, {'timestamp': self._timestamp()})
+    return (msg, {'time': self._time()})
 
   def _readall(self, size):
     """
@@ -133,6 +133,6 @@ def __call__(self, msg, **metadata):
     msg : SBP message
       SBP message to send.
     metadata : dict
-      {'timestamp': 'ISO 8601 str'} (ignored for now)
+      {'time': 'ISO 8601 str'} (ignored for now)
     """
     self._write(msg.to_binary())

python/data/serial_link_log_20150428-084729.log.dat

@@ -28,7 +28,7 @@ class Handler(object):
 
   Parameters
   ----------
-  source : Iterable of tuple(SBP message, {'timestamp':'ISO 8601 str'})
+  source : Iterable of tuple(SBP message, {'time':'ISO 8601 str'})
     Stream of SBP messages
   """
   def __init__(self, source):

python/sbp/client/framer.py

@@ -10,8 +10,6 @@
 
 from ...table import dispatch
 from construct.core import ConstructError
-import datetime
-import time
 import warnings
 
 class BaseLogger(object):
@@ -59,17 +57,6 @@ def dispatch(self, msg):
       data = msg
     return data
 
-  def timestamp(self):
-    """
-    Timestamp generator.
-
-    Returns
-    -------
-    str : ISO 8601
-    """
-    return datetime.datetime.utcnow().isoformat()
-
-
 class LogIterator(object):
   """
   LogIterator

python/sbp/client/handler.py

@@ -70,7 +70,7 @@ def next(self):
 
     Returns
     -------
-    Tuple(sbp MSG object, {'timestamp':'ISO 8601 time'})
+    Tuple(sbp MSG object, {'time':'ISO 8601 time'})
       Second item is for metadata. There used to be multiple fields and
       there could be more in the future.
 
@@ -126,7 +126,7 @@ def next(self):
 
     Returns
     -------
-    Tuple(sbp MSG object, {'timestamp':'ISO 8601 time'})
+    Tuple(sbp MSG object, {'time':'ISO 8601 time'})
       Second item is for metadata. There used to be multiple fields and
       there could be more in the future.
 
@@ -140,7 +140,7 @@ def next(self):
           warn = "Bad JSON decoding for line %s" % line
           warnings.warn(warn, RuntimeWarning)
 
-    for data in sorted(datas, key=itemgetter('timestamp')):
+    for data in sorted(datas, key=itemgetter('time')):
       item = SBP.from_json_dict(data.pop('data'))
       msg = self.dispatch(item)
       yield (msg, data)

python/sbp/client/loggers/base_logger.py

@@ -30,7 +30,7 @@ def test_log():
   log_datafile = "./data/serial_link_log_20150310-115522-test.log.dat"
   with LogIterator(log_datafile) as log:
     with pytest.raises(NotImplementedError) as exc_info:
-      for delta, timestamp, msg in log.next():
+      for msg, metadata in log.next():
         pass
   assert exc_info.value.message == "next() not implemented!"
 
@@ -43,8 +43,7 @@ def test_json_log():
   with warnings.catch_warnings(record=True) as w:
     with JSONLogIterator(log_datafile) as log:
       for msg, metadata in log.next():
-        assert type(metadata['delta']) == int
-        assert type(metadata['timestamp']) == int
+        assert type(metadata['time']) == unicode
         assert isinstance(msg, SBP) or issubclass(type(msg), SBP)
         count += 1
       warnings.simplefilter("always")
@@ -63,13 +62,12 @@ def test_multi_json_log():
   with warnings.catch_warnings(record=True) as w:
     with MultiJSONLogIterator(handles) as log:
       for msg, metadata in log.next():
-        assert type(metadata['delta']) == int
-        assert type(metadata['timestamp']) == int
+        assert type(metadata['time']) == unicode
         assert isinstance(msg, SBP) or issubclass(type(msg), SBP)
         assert type(metadata['metadata']) == dict
         assert not metadata['metadata']
-        assert metadata['timestamp'] >= past
-        past = metadata['timestamp']
+        assert metadata['time'] >= past
+        past = metadata['time']
         count += 1
       warnings.simplefilter("always")
       assert len(w) == 0
@@ -95,7 +93,7 @@ def test_msg_print():
   log_datafile = "./data/serial_link_log_20150428-084729.log.dat"
   with JSONLogIterator(log_datafile) as log:
     with warnings.catch_warnings(record=True) as w:
-      for delta, timestamp, msg in log.next():
+      for msg, metadata in log.next():
         pass
       warnings.simplefilter("always")
       # Check for warnings.