File: spheres.py

package info (click to toggle)
python-crownstone-cloud 1.4.11-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 240 kB
  • sloc: python: 1,126; makefile: 4
file content (137 lines) | stat: -rw-r--r-- 4,608 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
"""Sphere handler for Crownstone cloud data."""
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Iterator

from crownstone_cloud.cloud_models.crownstones import Crownstones
from crownstone_cloud.cloud_models.locations import Locations
from crownstone_cloud.cloud_models.users import Users

if TYPE_CHECKING:
    from crownstone_cloud.cloud import CrownstoneCloud


class Spheres:
    """Handler for the spheres of the user."""

    def __init__(self, cloud: CrownstoneCloud, user_id: str) -> None:
        """Initialization."""
        self.cloud = cloud
        self.user_id = user_id
        self.data: dict[str, Sphere] = {}

    def __iter__(self) -> Iterator[Sphere]:
        """Iterate over spheres."""
        return iter(self.data.values())

    async def async_update_sphere_data(self) -> None:
        """
        Get the spheres for the user from the cloud.

        This method is a coroutine.
        """
        cloud_data: list[dict[str, Any]] = await self.cloud.request_handler.get(
            "users", "spheres", model_id=self.user_id
        )
        # process items
        removed_items: list[str] = []
        new_items: list[str] = []
        for sphere in cloud_data:
            sphere_id: str = sphere["id"]
            exists = self.data.get(sphere_id)
            # check if the Sphere already exists
            # it is important that we don't throw away existing objects,
            # as they need to remain functional
            if exists:
                # update data
                self.data[sphere_id].data = sphere
            else:
                # add new Sphere
                self.data[sphere_id] = Sphere(self.cloud, sphere, self.user_id)

            # generate list with new id's to check with the existing id's
            new_items.append(sphere_id)

        # check for removed items
        for sphere_id in self.data:
            if sphere_id not in new_items:
                removed_items.append(sphere_id)

        # remove items from dict
        for sphere_id in removed_items:
            del self.data[sphere_id]

    def find(self, sphere_name: str) -> Sphere | None:
        """Search for a sphere by name and return sphere object if found."""
        for sphere in self.data.values():
            if sphere_name == sphere.name:
                return sphere

        return None

    def find_by_id(self, sphere_id: str) -> Sphere | None:
        """Search for a sphere by id and return sphere object if found."""
        return self.data.get(sphere_id)


class Sphere:
    """Represents a Sphere."""

    def __init__(
        self, cloud: CrownstoneCloud, data: dict[str, Any], user_id: str
    ) -> None:
        """Initialization."""
        self.cloud = cloud
        self.data = data
        self.user_id = user_id
        self.crownstones = Crownstones(self.cloud, self.cloud_id)
        self.locations = Locations(self.cloud, self.cloud_id)
        self.users = Users(self.cloud, self.cloud_id)
        self.keys: dict[str, str] = {}
        self.present_people: list[str] = []

    @property
    def name(self) -> str:
        """Returns the name of this Sphere."""
        return str(self.data["name"])

    @property
    def cloud_id(self) -> str:
        """Return the cloud id of this Sphere."""
        return str(self.data["id"])

    @property
    def unique_id(self) -> int:
        """Return the unique id of this Sphere."""
        return int(self.data["uid"])

    async def async_get_keys(self) -> dict[str, str]:
        """
        Get the user keys for this sphere, that can be used for BLE (optional).

        This method is a coroutine.
        """
        # get & reformat keys.
        keys: list[dict[str, Any]] = await self.cloud.request_handler.get(
            "users", "keysV2", model_id=self.user_id
        )
        for key_set in keys:
            if key_set["sphereId"] == self.cloud_id:
                for key_type in key_set["sphereKeys"]:
                    self.keys[key_type["keyType"]] = key_type["key"]

        return self.keys

    async def async_update_sphere_presence(self) -> None:
        """
        Replaces the current presence with that of the cloud.

        This method is a coroutine.
        """
        # get presence and create a list with user id's who are in the sphere.
        self.present_people = []
        presence_data: list[dict[str, Any]] = await self.cloud.request_handler.get(
            "Spheres", "presentPeople", model_id=self.cloud_id
        )
        for user in presence_data:
            self.present_people.append(user["userId"])