Existing cloud data can now be updated by running an update_data method. Changed async function prefix to async_. Added filter parameter to requestHandler get method. Updated tests & examples.

Author: RicArch97

crownstone_cloud/_RequestHandlerInstance.py

@@ -1,3 +1,4 @@
+"""Singleton that is used to perform all requests to the Crownstone cloud"""
 from crownstone_cloud.lib.requestHandler import RequestHandler
 
-RequestHandler = RequestHandler()
+RequestHandler = RequestHandler()

crownstone_cloud/__init__.py

@@ -1,2 +1,2 @@
 from crownstone_cloud._RequestHandlerInstance import RequestHandler
-from crownstone_cloud.lib.cloud import CrownstoneCloud
+from crownstone_cloud.lib.cloud import CrownstoneCloud

crownstone_cloud/const.py

@@ -1 +1,6 @@
-BASE_URL = "https://cloud.crownstone.rocks/api/"
+BASE_URL = "https://cloud.crownstone.rocks/api/"
+
+# Crownstone abilities
+DIMMING_ABILITY = 'dimming'
+SWITCHCRAFT_ABILITY = 'switchcraft'
+TAP_TO_TOGGLE_ABILITY = 'tapToToggle'

crownstone_cloud/lib/__init__.py

@@ -1,3 +1,3 @@
 """Library that communicates with the Crownstone lib"""
 
-__version__ = '1.1.3'
+__version__ = '1.2.0'

crownstone_cloud/lib/cloud.py

@@ -1,3 +1,4 @@
+"""Main class for the Crownstone cloud lib."""
 import hashlib
 import logging
 import asyncio
@@ -11,7 +12,7 @@
 
 
 class CrownstoneCloud:
-    """Create a Crownstone lib hub"""
+    """Create a Crownstone cloud instance."""
 
     def __init__(
             self,
@@ -28,15 +29,19 @@ def __init__(
         # data
         self.spheres: Optional[Spheres] = None
 
-    async def initialize(self) -> None:
-        """Async initialize the cloud data"""
+    async def async_initialize(self) -> None:
+        """
+        Initialize the cloud data.
+
+        This method is a coroutine.
+        """
         if RequestHandler.access_token is None:
-            await self.login()
-        await self.sync()
+            await self.async_login()
+        await self.async_synchronize()
 
-    def initialize_sync(self) -> None:
-        """Sync initialize the cloud data"""
-        self.loop.run_until_complete(self.initialize())
+    def initialize(self) -> None:
+        """Initialize the cloud data."""
+        self.loop.run_until_complete(self.async_initialize())
 
     @staticmethod
     def set_access_token(access_token: str) -> None:
@@ -46,8 +51,12 @@ def set_access_token(access_token: str) -> None:
     def get_access_token() -> str:
         return RequestHandler.access_token
 
-    async def login(self) -> None:
-        """Login to Crownstone API"""
+    async def async_login(self) -> None:
+        """
+        Login to Crownstone API.
+
+        This method is a coroutine.
+        """
         result = await RequestHandler.post('users', 'login', json=self.login_data)
 
         # Set access token & user id
@@ -56,53 +65,62 @@ async def login(self) -> None:
 
         _LOGGER.info("Login to Crownstone Cloud successful")
 
-    async def sync(self) -> None:
-        """Sync all data from cloud"""
-        _LOGGER.info("Initiating all cloud data, please wait...")
+    async def async_synchronize(self) -> None:
+        """
+        Sync all data from cloud.
+
+        This method is a coroutine.
+        """
+        _LOGGER.info("Initiating all cloud data")
         # get the sphere data
-        await self.spheres.update()
+        await self.spheres.async_update_sphere_data()
 
         # get the data from the sphere attributes
         for sphere in self.spheres:
             await asyncio.gather(
-                sphere.update_sphere_presence(),
-                sphere.crownstones.update(),
-                sphere.locations.update(),
-                sphere.users.update()
+                sphere.async_update_sphere_presence(),
+                sphere.crownstones.async_update_crownstone_data(),
+                sphere.locations.async_update_location_data(),
+                sphere.locations.async_update_location_presence(),
+                sphere.users.async_update_user_data()
             )
         _LOGGER.info("Cloud data successfully initialized")
 
     def get_crownstone(self, crownstone_name) -> Crownstone:
-        """Get a crownstone by name without specifying a sphere"""
+        """Get a crownstone by name without specifying a sphere."""
         for sphere in self.spheres:
             for crownstone in sphere.crownstones:
                 if crownstone.name == crownstone_name:
                     return crownstone
 
     def get_crownstone_by_id(self, crownstone_id) -> Crownstone:
-        """Get a crownstone by id without specifying a sphere"""
+        """Get a crownstone by id without specifying a sphere."""
         for sphere in self.spheres:
             return sphere.crownstones[crownstone_id]
 
     @staticmethod
     def reset() -> None:
-        """Cleanup the request handler instance data"""
+        """Cleanup the request handler instance data."""
         RequestHandler.access_token = None
         RequestHandler.login_data = None
 
     @staticmethod
-    async def close_session() -> None:
-        """Close the websession after we are done"""
+    async def async_close_session() -> None:
+        """
+        Close the websession after we are done.
+
+        This method is a coroutine.
+        """
         await RequestHandler.websession.close()
-        _LOGGER.warning("Session closed.")
+        _LOGGER.info("Session closed.")
 
-    def close_session_sync(self) -> None:
-        """Sync version of close session"""
-        self.loop.run_until_complete(self.close_session())
+    def close_session(self) -> None:
+        """Close the websession after we are done."""
+        self.loop.run_until_complete(self.async_close_session())
 
     @staticmethod
     def password_to_hash(password):
-        """Generate a sha1 password from string"""
+        """Generate a sha1 password from string."""
         if password is None:
             return None
         pw_hash = hashlib.sha1(password.encode('utf-8'))