added method to sync time, updated docstrings

Author: snorklerjoe

servercom/implementations/circuitpy.py

@@ -1,6 +1,7 @@
 """CircuitPython implementation of the CubeServer API Wrapper Library"""
 
 from .common import *
+from ..timetools import Time
 
 import ssl
 import wifi
@@ -379,6 +380,9 @@ def request(
         raise last_error
 
     def get_status(self) -> GameStatus:
+        """Gives the team access to their score and the current unix time.
+        Most teams probably won't need this.
+        """
         if self.v:
             print("Getting status...")
         resp = self.request('GET', '/status',
@@ -389,7 +393,16 @@ def get_status(self) -> GameStatus:
             print(f"It is {resp_json['unix_time']} seconds since the epoch.")
         return GameStatus(Time(resp_json['unix_time']), resp_json['status']['score'])
 
+    def sync_time(self) -> bool:
+        """Syncs the current clock against the server"""
+        status = self.get_status()
+        if status:
+            Time.set_time(status.time)
+            return True
+        return False
+
     def post(self, point: DataPoint) -> bool:
+        """Posts a DataPoint object to the server"""
         if self.v:
             print("Posting datapoint!")
         return self.request(
@@ -401,6 +414,7 @@ def post(self, point: DataPoint) -> bool:
         ).code == 201
 
     def email(self, msg: Email) -> bool:
+        """Sends an email to the team"""
         if self.v:
             print(f"Sending email {msg.subject}...")
         return self.request(

servercom/implementations/cpy.py

@@ -339,27 +339,44 @@ def request(
         raise last_error
 
     def get_status(self) -> GameStatus:
+        """Gives the team access to their score and the current unix time.
+        Most teams probably won't need this.
+        """
         resp = self.request('GET', '/status')
         resp_json = loads(resp[1])
         return GameStatus(Time(resp_json['unix_time']), resp_json['status']['score'])
+    
+    def sync_time(self) -> bool:
+        """Syncs the current clock against the server"""
+        status = self.get_status()
+        if status:
+            Time.set_time(status.time)
+            return True
+        return False
 
     def post(self, point: DataPoint) -> bool:
+        """Posts a DataPoint object to the server"""
         return self.request(
             'POST',
             '/data',
             point.dumps(),
             content_type = 'application/json',
-            headers=['User-Agent: CPython, dude!']
+            headers=['User-Agent: CPythonDude']
         ).code == 201
     def email(self, msg: Email) -> bool:
+        """Sends an email to the team"""
         return self.request(
             'POST',
             '/email',
             msg.dumps(),
             content_type = 'application/json',
-            headers=['User-Agent: CPython, dude!']
+            headers=['User-Agent: CPythonDude']
         ).code == 201
     def code_update(reset=True):
+        """THIS FEATURE IS NOT IMPLEMENTED FOR CPython.
+        Checks for a code update from the server.
+        Restarts the microcontroller and run the new code if it is available
+        """
         pass
     def __exit__(self):
         if self.v:

servercom/timetools.py

@@ -26,10 +26,14 @@ class Time(Immutable):
 
     # Class Methods:
     @classmethod
-    def set_time(cls, unix_timestamp: int) -> None:
+    def set_unix_time(cls, unix_timestamp: int) -> None:
         cls._timeset = (int(monotonic()), int(unix_timestamp))
         cls._time_offset = int(unix_timestamp - monotonic())
 
+    @classmethod
+    def set_time(cls, current_time: 'Time') -> None:
+        cls.set_unix_time(current_time.seconds)
+
     @classmethod
     def from_unix_time(cls, unix_time: int) -> int:
         """Returns a monotonic timestamp from a unix timestamp"""