File: client.py

package info (click to toggle)
python-asusrouter 1.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,856 kB
  • sloc: python: 20,497; makefile: 3
file content (363 lines) | stat: -rw-r--r-- 9,329 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
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
"""Client module for AsusRouter."""

from __future__ import annotations

from dataclasses import dataclass
from datetime import datetime
from typing import Any

from asusrouter.modules.connection import (
    ConnectionState,
    ConnectionType,
    InternetMode,
    get_connection_type,
    get_internet_mode,
)
from asusrouter.modules.const import MapValueType
from asusrouter.modules.ip_address import IPAddressType, read_ip_address_type
from asusrouter.modules.vendor import replace_vendor
from asusrouter.tools.converters import (
    safe_bool,
    safe_float,
    safe_int,
    safe_time_from_delta,
    safe_unpack_key,
)


@dataclass
class AsusClient:
    """Client class."""

    state: ConnectionState = ConnectionState.UNKNOWN

    description: AsusClientDescription | None = None

    connection: AsusClientConnection | None = None


@dataclass
class AsusClientConnection:
    """Connection class."""

    type: ConnectionType = ConnectionType.DISCONNECTED
    ip_address: str | None = None
    ip_method: str | None = None
    internet_state: bool | None = None
    internet_mode: InternetMode = InternetMode.UNKNOWN
    node: str | None = None
    online: bool = False

    # Is an AiMesh node
    aimesh: bool | None = None


@dataclass
class AsusClientConnectionWlan(AsusClientConnection):
    """WLAN connection class."""

    guest: bool | None = None
    guest_id: int | None = None
    rssi: int | None = None
    since: datetime | None = None
    rx_speed: float | None = None
    tx_speed: float | None = None


@dataclass
class AsusClientDescription:
    """Client description class."""

    name: str | None = None
    mac: str | None = None

    vendor: str | None = None


CLIENT_MAP: dict[str, list[MapValueType]] = {
    "connected_since": [
        ("wlConnectTime", safe_time_from_delta),
    ],
    "connection_type": [
        ("connection_type"),
        ("isWL", safe_int),
    ],
    "guest": [
        ("guest"),
        ("isGN", safe_int),
    ],
    "internet_mode": [
        ("internetMode", get_internet_mode),
    ],
    "internet_state": [
        ("internetState", safe_bool),
    ],
    "ip": [
        ("ip"),
    ],
    "ip_method": [
        ("ipMethod"),
    ],
    "mac": [
        ("mac"),
    ],
    "name": [
        ("nickName"),
        ("name"),
        ("mac"),
    ],
    "node": [
        ("node"),
    ],
    "online": [
        ("online"),
        ("isOnline", safe_bool),
    ],
    "rssi": [
        ("rssi", safe_int),
    ],
    "rx_speed": [
        ("curRx", safe_float),
    ],
    "tx_speed": [
        ("curTx", safe_float),
    ],
}

CLIENT_MAP_DESCRIPTION: dict[str, list[MapValueType]] = {
    "name": [
        ("nickName"),
        ("name"),
        ("mac"),
    ],
    "mac": [
        ("mac"),
    ],
    "vendor": [
        ("vendor", replace_vendor),
    ],
}

CLIENT_MAP_CONNECTION: dict[str, list[MapValueType]] = {
    "type": [
        ("connection_type", get_connection_type),
        ("isWL", get_connection_type),
    ],
    "ip_address": [
        ("ip"),
    ],
    "ip_method": [
        ("ipMethod", read_ip_address_type),
    ],
    "internet_state": [
        ("internetState", safe_bool),
    ],
    "internet_mode": [
        ("internetMode", get_internet_mode),
    ],
    "node": [
        ("node"),
    ],
    "online": [
        ("online", safe_bool),
        ("isOnline", safe_bool),
    ],
    "aimesh": [
        ("amesh_isRe", safe_bool),
    ],
}

CLIENT_MAP_CONNECTION_WLAN: dict[str, list[MapValueType]] = {
    "guest_id": [
        ("guest"),
        ("isGN", safe_int),
    ],
    "rssi": [
        ("rssi", safe_int),
    ],
    "since": [
        ("wlConnectTime", safe_time_from_delta),
    ],
    "rx_speed": [
        ("curRx", safe_float),
    ],
    "tx_speed": [
        ("curTx", safe_float),
    ],
}


def process_client(
    data: dict[str, Any], history: AsusClient | None = None, **kwargs: Any
) -> AsusClient:
    """
    Process client data.

    Parameters:
    data (dict[str, Any]): The client data to process.
    history (Optional[AsusClient]): The previous state of the client, if any.

    Returns:
    AsusClient: The processed client data.
    """

    description: AsusClientDescription = process_client_description(data)
    connection: AsusClientConnection | AsusClientConnectionWlan = (
        process_client_connection(data)
    )

    state: ConnectionState = process_client_state(connection, **kwargs)

    # Clean disconnected client
    if state != ConnectionState.CONNECTED:
        connection = process_disconnected(connection)

    # Check history for the oscillating values
    if history is not None and history.connection is not None:
        connection = process_history(connection, history.connection)

    return AsusClient(
        state=state, description=description, connection=connection
    )


def process_data(
    data: dict[str, Any], mapping: dict[str, Any], obj: Any
) -> Any:
    """Process data based on a mapping and set attributes on an object."""

    # Go through all keys in mapping
    for key, value in mapping.items():
        for pair in value:
            # Get the search key and converter(s)
            key_to_find, converters = safe_unpack_key(pair)
            # Get the value from the data
            item = data.get(key_to_find)

            # Process the value if it's an actual value
            if item is not None and item != "":
                # Apply converters one by one if there are multiple
                if isinstance(converters, list):
                    for converter in converters:
                        item = converter(item)
                # Apply single converter
                elif converters:
                    item = converters(item)

                # Set the attribute on the object
                setattr(obj, key, item)

                # We found the value, no need to continue searching
                break

    return obj


def process_client_description(data: dict[str, Any]) -> AsusClientDescription:
    """Process client description data."""

    return process_data(data, CLIENT_MAP_DESCRIPTION, AsusClientDescription())


def process_client_connection(data: dict[str, Any]) -> AsusClientConnection:
    """Process client connection data."""

    connection = process_data(
        data, CLIENT_MAP_CONNECTION, AsusClientConnection()
    )

    if connection.type not in (
        ConnectionType.WIRED,
        ConnectionType.DISCONNECTED,
    ):
        connection = process_client_connection_wlan(data, connection)

    return connection


def process_client_connection_wlan(
    data: dict[str, Any], base_connection: AsusClientConnection
) -> AsusClientConnectionWlan:
    """Process WLAN client connection data."""

    wlan_connection = AsusClientConnectionWlan(**base_connection.__dict__)
    wlan_connection = process_data(
        data, CLIENT_MAP_CONNECTION_WLAN, wlan_connection
    )

    # Mark `guest` attribute if `guest_id` is non-zero
    wlan_connection.guest = (
        wlan_connection.guest_id != 0 and wlan_connection.guest_id is not None
    )

    return wlan_connection


def process_client_state(
    connection: AsusClientConnection,
    **kwargs: Any,
) -> ConnectionState:
    """Process client state."""

    # If no IP address or type is disconnected, it's disconnected
    if (
        connection.ip_address is None
        or connection.type == ConnectionType.DISCONNECTED
    ):
        return ConnectionState.DISCONNECTED

    # If client is an AiMesh node, it's not a client
    if connection.aimesh is True:
        return ConnectionState.DISCONNECTED

    # If we have support for AiMesh but no node, client is disconnected
    aimesh = kwargs.get("aimesh", False)
    if aimesh is True and connection.node is None:
        return ConnectionState.DISCONNECTED

    # This one is a weak check, should always be the last one
    if connection.online is True:
        return ConnectionState.CONNECTED

    return ConnectionState.DISCONNECTED


def process_disconnected(
    connection: AsusClientConnection,
) -> AsusClientConnection:
    """Process disconnected client."""

    # We keep values set by the user:
    # - internet mode
    # - ip method
    # - ip address if ip method is static
    return AsusClientConnection(
        type=ConnectionType.DISCONNECTED,
        ip_address=connection.ip_address
        if connection.ip_method == IPAddressType.STATIC
        else None,
        ip_method=connection.ip_method,
        internet_mode=connection.internet_mode,
    )


def process_history(
    connection: AsusClientConnection, history: AsusClientConnection
) -> AsusClientConnection:
    """Process values from history to avoid oscillating values."""

    # Wireless connection
    if (
        isinstance(connection, AsusClientConnectionWlan)
        and isinstance(history, AsusClientConnectionWlan)
        and connection.since is not None
        and history.since is not None
    ):
        # Fix the oscillating connection time: ignore any value less
        # than 10 seconds. This comes from the device itself and cannot
        # be fixed from AsusRouter side.
        diff = abs((history.since - connection.since).total_seconds())
        if diff < 10:  # noqa: PLR2004
            connection.since = history.since

    return connection