File: locations.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 (113 lines) | stat: -rw-r--r-- 3,815 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
"""Location handler for Crownstone cloud data."""
from __future__ import annotations

from typing import TYPE_CHECKING, Any, Iterator

if TYPE_CHECKING:
    from crownstone_cloud.cloud import CrownstoneCloud


class Locations:
    """Handler for the locations of a sphere."""

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

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

    async def async_update_location_data(self) -> None:
        """
        Get the locations and presence from the cloud.

        This method is a coroutine.
        """
        cloud_data: list[dict[str, Any]] = await self.cloud.request_handler.get(
            "Spheres", "ownedLocations", model_id=self.sphere_id
        )
        # process items
        removed_items: list[str] = []
        new_items: list[str] = []
        for location in cloud_data:
            location_id: str = location["id"]
            exists = self.data.get(location_id)
            # check if the location 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[location_id].data = location
            else:
                # add new Location
                self.data[location_id] = Location(location)

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

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

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

    async def async_update_location_presence(self) -> None:
        """
        Get the presentPeople for this Sphere, and get the users in this Location.

        This method is a coroutine.
        """
        presence_data: list[dict[str, Any]] = await self.cloud.request_handler.get(
            "Spheres", "presentPeople", model_id=self.sphere_id
        )
        # reset the presence
        for location in self.data.values():
            location.present_people = []
        # add new presence
        for presence in presence_data:
            for present_location in presence["locations"]:
                for location in self.data.values():
                    if present_location == location.cloud_id:
                        location.present_people.append(presence["userId"])

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

        return None

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


class Location:
    """Represents a Location."""

    def __init__(self, data: dict[str, Any]) -> None:
        """Initialization."""
        self.data = data
        self.present_people: list[str] = []

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

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

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