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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
#
# Copyright 2019 aiohomekit team
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from __future__ import annotations
from collections.abc import Iterable, Iterator
from typing import TYPE_CHECKING, Any
from aiohomekit.model.characteristics import Characteristic, CharacteristicsTypes
from aiohomekit.model.characteristics.characteristic import check_convert_value
from aiohomekit.model.services.data import services
from aiohomekit.uuid import normalize_uuid
if TYPE_CHECKING:
from aiohomekit.model import Accessory
class Characteristics:
"""Represents a collection of characteristics."""
_characteristics: list[Characteristic]
def __init__(self) -> None:
"""Initialise a collection of characteristics."""
self._characteristics = []
self._iid_to_characteristic: dict[int, Characteristic] = {}
def append(self, char: Characteristic) -> None:
"""Add a characteristic."""
self._characteristics.append(char)
self._iid_to_characteristic[char.iid] = char
def get(self, iid: int) -> Characteristic:
"""Get a characteristic by iid."""
return self._iid_to_characteristic.get(iid)
def __iter__(self) -> Iterator[Characteristic]:
"""Iterate over characteristics."""
return iter(self._characteristics)
def filter(
self, char_types: Iterable[str] | None = None
) -> Iterator[Characteristic]:
"""Filter characteristics by type."""
matches = iter(self)
if char_types:
char_types = {normalize_uuid(c) for c in char_types}
matches = filter(lambda char: char.type in char_types, matches)
return matches
def first(self, char_types: Iterable[str] | None = None) -> Characteristic:
"""Get the first characteristic."""
return next(self.filter(char_types=char_types))
class Service:
"""Represents a service on an accessory."""
type: str
iid: int
linked: set[Service]
characteristics: Characteristics
characteristics_by_type: dict[str, Characteristic]
accessory: Accessory
def __init__(
self,
accessory: Accessory,
service_type: str,
name: str | None = None,
add_required: bool = False,
iid: int | None = None,
) -> None:
"""Initialise a service."""
self.type = normalize_uuid(service_type)
self.accessory = accessory
self.iid = iid or accessory.get_next_id()
self.characteristics = Characteristics()
self.characteristics_by_type: dict[str, Characteristic] = {}
self.linked: list[Service] = []
if name:
char = self.add_char(CharacteristicsTypes.NAME)
char.set_value(name)
if add_required:
for required in services[self.type]["required"]:
if required not in self.characteristics_by_type:
self.add_char(required)
def has(self, char_type: str) -> bool:
"""Return True if the service has a characteristic."""
return normalize_uuid(char_type) in self.characteristics_by_type
def value(self, char_type: str, default_value: Any | None = None) -> Any:
"""Return the value of a characteristic."""
char_type = normalize_uuid(char_type)
if char_type not in self.characteristics_by_type:
return default_value
return self.characteristics_by_type[char_type].value
def __getitem__(self, key) -> Characteristic:
"""Get a characteristic by type."""
return self.characteristics_by_type[normalize_uuid(key)]
def add_char(self, char_type: str, **kwargs: Any) -> Characteristic:
"""Add a characteristic to the service."""
char = Characteristic(self, char_type, **kwargs)
self.characteristics.append(char)
self.characteristics_by_type[char.type] = char
return char
def get_char_by_iid(self, iid: int) -> Characteristic | None:
"""Get a characteristic by iid."""
return self.characteristics.get(iid)
def add_linked_service(self, service: Service) -> None:
"""Add a linked service."""
self.linked.append(service)
def build_update(self, payload: dict[str, Any]) -> list[tuple[int, int, Any]]:
"""
Given a payload in the form of {CHAR_TYPE: value}, render in a form suitable to pass
to put_characteristics using aid and iid.
"""
result = []
for char_type, value in payload.items():
char = self[char_type]
value = check_convert_value(value, char)
result.append((self.accessory.aid, char.iid, value))
return result
def to_accessory_and_service_list(self) -> dict[str, Any]:
"""Return the service as a dictionary."""
characteristics_list = []
for c in self.characteristics:
characteristics_list.append(c.to_accessory_and_service_list())
d = {
"iid": self.iid,
"type": self.type,
"characteristics": characteristics_list,
}
if linked := [service.iid for service in self.linked]:
d["linked"] = linked
return d
@property
def available(self) -> bool:
"""Return True if all characteristics are available."""
return all(c.available for c in self.characteristics)
|
