Added getting the dimming ability for every crownstone. Updated update functions

Author: RicArch97

crownstone_cloud/lib/__init__.py

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

crownstone_cloud/lib/cloud.py

@@ -61,7 +61,7 @@ async def login(self) -> None:
 
     async def sync(self) -> None:
         """Sync all data from cloud"""
-        _LOGGER.warning("Initiating all cloud data, please wait...")
+        _LOGGER.info("Initiating all cloud data, please wait...")
         # get the sphere data
         await self.spheres.update()
 
@@ -70,12 +70,10 @@ async def sync(self) -> None:
             await asyncio.gather(
                 sphere.update_sphere_presence(),
                 sphere.crownstones.update(),
-                sphere.crownstones.update_state(),
                 sphere.locations.update(),
-                sphere.locations.update_location_presence(),
                 sphere.users.update()
             )
-        _LOGGER.warning("Cloud data successfully initialized")
+        _LOGGER.info("Cloud data successfully initialized")
 
     def get_crownstone(self, crownstone_name) -> Crownstone:
         """Get a crownstone by name without specifying a sphere"""

crownstone_cloud/lib/cloudModels/crownstones.py

@@ -21,7 +21,20 @@ def __iter__(self):
 
     async def update(self) -> None:
         """
-        Get the crownstones and their state for this sphere from the cloud
+        Update all cloud data
+        The requests are done separately for testing.
+        """
+        # get all data first
+        await self.update_crownstone_data()
+        # get the other data concurrently
+        await asyncio.gather(
+            self.update_state(),
+            self.update_abilities()
+        )
+
+    async def update_crownstone_data(self) -> None:
+        """
+        Get the crownstones data from the cloud
         This will replace all current data from the cloud with new data
         """
         self.crownstones = {}
@@ -35,14 +48,20 @@ async def update_state(self) -> None:
             crownstone_state = await RequestHandler.get('Stones', 'currentSwitchState', model_id=crownstone.cloud_id)
             crownstone.state = crownstone_state['switchState']
 
+    async def update_abilities(self) -> None:
+        """Get the abilities for all crownstones"""
+        # only dimming is requested for now
+        for crownstone in self.crownstones.values():
+            abilities = await RequestHandler.get('Stones', 'abilities', model_id=crownstone.cloud_id)
+            for ability in abilities:
+                if ability['type'] == 'dimming':
+                    crownstone.dimming_enabled = ability['enabled']
+                    crownstone.dimming_synced_to_crownstone = ability['syncedToCrownstone']
+
     def update_sync(self) -> None:
         """Sync function for updating the crownstone data"""
         self.loop.run_until_complete(self.update())
 
-    def update_state_sync(self) -> None:
-        """Sync function for updating the crownstone state"""
-        self.loop.run_until_complete(self.update_state())
-
     def find(self, crownstone_name: str) -> object or None:
         """Search for a crownstone by name and return crownstone object if found"""
         for crownstone in self.crownstones.values():
@@ -63,7 +82,8 @@ def __init__(self, loop: asyncio.AbstractEventLoop, data: dict) -> None:
         self.loop = loop
         self.data = data
         self.state: Optional[float] = None
-        self.dimming_enabled = False
+        self.dimming_enabled: Optional[bool] = None
+        self.dimming_synced_to_crownstone: Optional[bool] = None
 
     @property
     def name(self) -> str:
@@ -110,12 +130,16 @@ async def set_brightness(self, percentage: int) -> None:
         :param percentage: the brightness percentage (0 - 100)
         """
         if self.dimming_enabled:
-            if percentage < 0 or percentage > 100:
-                raise ValueError("Enter a percentage between 0 and 100")
+            if self.dimming_synced_to_crownstone:
+                if percentage < 0 or percentage > 100:
+                    raise ValueError("Enter a percentage between 0 and 100")
+                else:
+                    brightness = percentage / 100
+                    await RequestHandler.put('Stones', 'setSwitchStateRemotely', model_id=self.cloud_id,
+                                             command='switchState', value=brightness)
             else:
-                brightness = percentage / 100
-                await RequestHandler.put('Stones', 'setSwitchStateRemotely', model_id=self.cloud_id,
-                                         command='switchState', value=brightness)
+                _LOGGER.error("Dimming is enabled but not synced to crownstone yet. Make sure to be in your sphere "
+                              "and have Bluetooth enabled")
         else:
             _LOGGER.error("Dimming is not enabled for this crownstone. Go to the crownstone app to enable it")
 
@@ -125,4 +149,4 @@ def set_brightness_sync(self, percentage: int) -> None:
 
         :param percentage: the brightness percentage (0 - 100)
         """
-        self.loop.run_until_complete(self.set_brightness(percentage))
+        self.loop.run_until_complete(self.set_brightness(percentage))

crownstone_cloud/lib/cloudModels/locations.py

@@ -17,6 +17,16 @@ def __iter__(self):
         return iter(self.locations.values())
 
     async def update(self) -> None:
+        """
+        Update all cloud data
+        The requests are done separately for testing.
+        """
+        # get location data first
+        await self.update_location_data()
+        # get the presence
+        await self.update_location_presence()
+
+    async def update_location_data(self) -> None:
         """
         Get the locations and presence from the cloud
         This will replace all current data with new data from the cloud
@@ -39,10 +49,6 @@ def update_sync(self) -> None:
         """Sync function for updating the location data"""
         self.loop.run_until_complete(self.update())
 
-    def update_presence_sync(self) -> None:
-        """Sync function for updating the presence"""
-        self.loop.run_until_complete(self.update_location_presence())
-
     def find(self, location_name: str) -> object or None:
         """Search for a sphere by name and return sphere object if found"""
         for location in self.locations.values():

crownstone_cloud/lib/cloudModels/spheres.py

@@ -24,6 +24,7 @@ async def update(self) -> None:
         Get the spheres for the user from the cloud
         This will replace all current data with new data from the cloud
         """
+        # get sphere data
         self.spheres = {}
         sphere_data = await RequestHandler.get('users', 'spheres', model_id=self.user_id)
         for sphere in sphere_data:

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='crownstone-lib-python-cloud',
-    version='1.0.5',
+    version='1.1.0',
     url='https://github.com/crownstone/crownstone-lib-python-cloud',
     author='Crownstone B.V.',
     description='Async library to get & store data from the Crownstone cloud.',

tests/test_cloud.py

@@ -94,7 +94,7 @@ async def test_data_structure(self, mock_request):
 
         # add fake crownstone data for test
         mock_request.return_value = crownstone_data
-        await sphere.crownstones.update()
+        await sphere.crownstones.update_crownstone_data()
         mock_request.assert_awaited()
         # state
         mock_request.return_value = switch_state_data
@@ -108,7 +108,7 @@ async def test_data_structure(self, mock_request):
 
         # add fake location data for test
         mock_request.return_value = location_data
-        await sphere.locations.update()
+        await sphere.locations.update_location_data()
         mock_request.assert_awaited()
         # presence
         mock_request.return_value = presence_data
@@ -146,5 +146,6 @@ async def test_data_structure(self, mock_request):
             brightness_mock.assert_not_called()
             # set dimming to true for test
             crownstone.dimming_enabled = True
+            crownstone.dimming_synced_to_crownstone = True
             with self.assertRaises(ValueError):
                 await crownstone.set_brightness(200)