Rework Cloud log start/end times, and update documentation

Author: uzlonewolf

README.md

@@ -392,13 +392,15 @@ result = c.sendcommand(id,commands)
 print("Results\n:", result)
 ```
 
-Up to one week of device logs can also be pulled from the Cloud.  By default getdevicelog() will pull 1 day of logs or 100 log entries, whichever comes first.
+Up to one week of device logs can also be pulled from the Cloud.  By default getdevicelog() will pull 1 day of logs or 100 log entries, whichever comes first.  The returned timestamps are unixtime*1000, and event_id 7 (data report) will probably be the most useful.
 
 ```python
 import tinytuya
 import json
 
 c = tinytuya.Cloud()
+#r = c.getdevicelog( '00112233445566778899', start=-1, end=0, size=100 )
+#r = c.getdevicelog( '00112233445566778899', start=1669990000, end=1669990300, size=20 )
 r = c.getdevicelog( '00112233445566778899' )
 print( json.dumps(r, indent=2) )
 ```

examples/cloud.py

@@ -64,3 +64,19 @@
 result = c.sendcommand(id,commands)
 print("Results\n:", result)
 
+# Get device logs
+# Note: the returned timestamps are unixtime*1000
+# event_id 7 (data report) will probably be the most useful
+# More information can be found at https://developer.tuya.com/en/docs/cloud/cbea13f274?id=Kalmcohrembze
+
+# Get device logs from the last day
+result = c.getdevicelog(id)
+print("Device logs:\n", result)
+
+# Get device logs from 7 days ago through 5 days ago (2 days worth)
+#result = c.getdevicelog(id, start=-7, end=-5)
+#print("Device logs:\n", result)
+
+# Get device logs for one day ending an hour ago
+#result = c.getdevicelog(id, end=time.time() - 3600)
+#print("Device logs:\n", result)

tinytuya/Cloud.py

@@ -21,6 +21,8 @@
         sendcommand(deviceid, commands)
         getconnectstatus(deviceid)
         getdevicelog(deviceid, start=[now - 1 day], end=[now], evtype="1,2,3,4,5,6,7,8,9,10", size=100, params={})
+          -> when start or end are negative, they are the number of days before "right now"
+             i.e. "start=-1" is 1 day ago, "start=-7" is 7 days ago
 """
 
 from .core import *
@@ -78,6 +80,7 @@ def __init__(self, apiRegion=None, apiKey=None, apiSecret=None, apiDeviceID=None
         self.token = None
         self.error = None
         self.new_sign_algorithm = new_sign_algorithm
+        self.server_time_offset = 0
 
         if (not apiKey) or (not apiSecret):
             try:
@@ -245,6 +248,12 @@ def _gettoken(self):
             )
             return self.error
 
+        if 't' in response_dict:
+            # round it to 2 minutes to try and factor out any processing delays
+            self.server_time_offset = round( ((response_dict['t'] / 1000.0) - time.time()) / 120 )
+            self.server_time_offset *= 120
+            log.warning(self.server_time_offset)
+
         self.token = response_dict['result']['access_token']
         return self.token
 
@@ -476,10 +485,24 @@ def getdevicelog(self, deviceid=None, start=None, end=None, evtype=None, size=10
                 ERR_PARAMS,
                 "Missing DeviceID Parameter"
             )
+
+        # server expects times as unixtime * 1000
         if not end:
-            end = int(time.mktime(time.gmtime()))
+            end = int((time.time() + self.server_time_offset) * 1000)
+        elif end < 0:
+            end = int(((time.time() + self.server_time_offset) + (end * 86400) ) * 1000)
+        else:
+            end = Cloud.format_timestamp( end )
         if not start:
-            start = end - 86400
+            start = end - (86400*1000)
+        elif start < 0:
+            start = int(((time.time() + self.server_time_offset) + (start * 86400) ) * 1000)
+        else:
+            start = Cloud.format_timestamp( start )
+        if start > end:
+            tmp = start
+            start = end
+            end = tmp
         if not evtype:
             # get them all by default
             # 1 = device online, 7 = DP report
@@ -499,3 +522,15 @@ def getdevicelog(self, deviceid=None, start=None, end=None, evtype=None, size=10
             params['query_type'] = 1
 
         return self.cloudrequest( '/v1.0/devices/%s/logs' % deviceid, query=params)
+
+    @staticmethod
+    def format_timestamp( ts ):
+        # converts a 10-digit unix timestamp to the 13-digit stamp the servers expect
+        if type(ts) != int:
+            if len(str(int(ts))) == 10:
+                ts = int( ts * 1000 )
+            else:
+                ts = int( ts )
+        elif len(str(ts)) == 10:
+            ts *= 1000
+        return ts