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
|
"""Data finder module."""
from __future__ import annotations
from collections.abc import Callable
from enum import Enum
import logging
from asusrouter.modules.attributes import AsusRouterAttribute
from asusrouter.modules.data import AsusData
from asusrouter.modules.endpoint import Endpoint, EndpointTools, EndpointType
from asusrouter.modules.endpoint.hook_const import (
MAP_OVPN_SERVER_388,
MAP_VPNC_WIREGUARD,
MAP_WAN,
MAP_WAN_ITEM,
MAP_WAN_ITEM_X,
MAP_WIREGUARD_CLIENT,
MAP_WIREGUARD_SERVER,
)
from asusrouter.modules.parental_control import HOOK_PC
from asusrouter.modules.wlan import gwlan_nvram_request, wlan_nvram_request
from asusrouter.tools import converters
_LOGGER = logging.getLogger(__name__)
class AsusDataMerge(str, Enum):
"""AsusRouter data merge class."""
ALL = "all"
ANY = "any"
class AsusDataFinder:
"""AsusRouter data finder class."""
def __init__( # noqa: PLR0913
self,
endpoint: list[EndpointType] | EndpointType,
merge: AsusDataMerge = AsusDataMerge.ANY,
request: list[tuple[str, ...]] | None = None,
nvram: list[str] | str | None = None,
method: Callable | None = None,
arguments: AsusRouterAttribute | None = None,
) -> None:
"""Initialize the data finder."""
# Set the endpoint as list even if it's a single endpoint
if not isinstance(endpoint, list):
endpoint = [endpoint]
self.endpoint = endpoint
# Set the merge
self.merge = merge
# Set the request and append nvram hooks to the request
self.request = request or []
if nvram:
nvram_request = converters.nvram_get(nvram)
if nvram_request:
self.request.extend(nvram_request)
# Set the method and arguments
self.method = method
self.arguments = arguments
# A constant list of requests for fetching data
ASUSDATA_REQUEST = {
"devices": [
("get_clientlist", ""),
],
"main": [
("cpu_usage", "appobj"),
("memory_usage", "appobj"),
("netdev", "appobj"),
],
"speedtest": [
("ookla_speedtest_get_result", ""),
],
# "speedtest_history": [
# ("ookla_speedtest_get_history", ""),
# ],
# "speedtest_servers": [
# ("ookla_speedtest_get_servers", ""),
# ],
"vpnc": [
("get_vpnc_status", ""),
],
"wan": [
("get_wan_unit", ""),
],
"wireguard_server": [
("get_wgsc_status", ""),
],
}
ASUSDATA_NVRAM = {
"aura": [
"AllLED",
"ledg_night_mode",
"ledg_scheme",
"ledg_scheme_old",
],
"ddns": [
"ddns_enable_x",
"ddns_hostname_x",
"ddns_ipaddr",
"ddns_old_name",
"ddns_replace_status",
"ddns_return_code",
"ddns_return_code_chk",
"ddns_server_x",
"ddns_updated",
],
"light": ["led_val"],
"openvpn_server_388": [
key
for element in MAP_OVPN_SERVER_388
for key, _, _ in [converters.safe_unpack_keys(element)]
],
"parental_control": HOOK_PC,
"port_forwarding": [
"vts_rulelist",
"vts_enable_x",
],
"speedtest": ["ookla_state"],
"vpnc": [
"vpnc_clientlist",
],
"wan": [
key
for element in MAP_WAN
for key, _, _ in [converters.safe_unpack_keys(element)]
if key != "get_wan_unit"
],
"wireguard_server": [
key
for element in MAP_WIREGUARD_SERVER
for key, _, _ in [converters.safe_unpack_keys(element)]
if key != "get_wgsc_status"
],
"dsl": [
"dsllog_dataratedown",
"dsllog_datarateup",
],
}
ASUSDATA_NVRAM["aura"].extend([f"ledg_rgb{num}" for num in range(8)])
ASUSDATA_NVRAM["vpnc"].extend(
[
f"wgc{num}_{key}"
for num in range(1, 6)
for element in MAP_VPNC_WIREGUARD
for key, _, _ in [converters.safe_unpack_keys(element)]
]
)
ASUSDATA_NVRAM["wan"].extend(
[
f"wan{num}_{key}"
for num in (0, 1)
for element in MAP_WAN_ITEM
for key, _, _ in [converters.safe_unpack_keys(element)]
]
)
ASUSDATA_NVRAM["wan"].extend(
[
f"wan{num}_{extra}{key}"
for num in (0, 1)
for extra in ("", "x")
for element in MAP_WAN_ITEM_X
for key, _, _ in [converters.safe_unpack_keys(element)]
]
)
ASUSDATA_NVRAM["wireguard_server"].extend(
[
f"wgs1_c{num}_{key}"
for num in range(1, 11)
for element in MAP_WIREGUARD_CLIENT
for key, _, _ in [converters.safe_unpack_keys(element)]
]
)
ASUSDATA_ENDPOINT_APPEND = {
Endpoint.PORT_STATUS: {
# Request status of the ports for the whole AiMesh network
# This will save time and requests, since we then cache the data
# in most cases
"node_mac": "all",
}
}
# A map of endptoins to get data from
ASUSDATA_MAP: dict[AsusData, AsusData | AsusDataFinder] = {
AsusData.AIMESH: AsusDataFinder(Endpoint.ONBOARDING),
AsusData.AURA: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["aura"],
),
AsusData.BOOTTIME: AsusData.DEVICEMAP,
AsusData.CLIENTS: AsusDataFinder(
[Endpoint.ONBOARDING, Endpoint.UPDATE_CLIENTS], AsusDataMerge.ALL
),
AsusData.CPU: AsusDataFinder(
Endpoint.HOOK, request=ASUSDATA_REQUEST["main"]
),
AsusData.DDNS: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["ddns"],
),
AsusData.DEVICEMAP: AsusDataFinder(Endpoint.DEVICEMAP),
AsusData.FIRMWARE: AsusDataFinder(Endpoint.FIRMWARE),
AsusData.FIRMWARE_NOTE: AsusDataFinder(
[Endpoint.FIRMWARE_NOTE, Endpoint.FIRMWARE_NOTE_AIMESH]
),
AsusData.GWLAN: AsusDataFinder(
Endpoint.HOOK,
method=gwlan_nvram_request,
arguments=AsusRouterAttribute.WLAN_LIST,
),
AsusData.LED: AsusDataFinder(Endpoint.HOOK, nvram=ASUSDATA_NVRAM["light"]),
AsusData.NETWORK: AsusData.CPU,
AsusData.NODE_INFO: AsusDataFinder(Endpoint.PORT_STATUS),
AsusData.OPENVPN: AsusDataFinder(
[Endpoint.VPN, Endpoint.DEVICEMAP], AsusDataMerge.ANY
),
AsusData.OPENVPN_CLIENT: AsusData.OPENVPN,
AsusData.OPENVPN_SERVER: AsusData.OPENVPN,
AsusData.PARENTAL_CONTROL: AsusDataFinder(
Endpoint.HOOK, nvram=ASUSDATA_NVRAM["parental_control"]
),
AsusData.PING: AsusDataFinder(EndpointTools.NETWORK),
AsusData.PORT_FORWARDING: AsusDataFinder(
Endpoint.HOOK, nvram=ASUSDATA_NVRAM["port_forwarding"]
),
AsusData.PORTS: AsusDataFinder(
[Endpoint.PORT_STATUS, Endpoint.ETHERNET_PORTS]
),
AsusData.RAM: AsusData.CPU,
AsusData.SPEEDTEST: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["speedtest"],
request=ASUSDATA_REQUEST["speedtest"],
),
# AsusData.SPEEDTEST_HISTORY: AsusDataFinder(
# Endpoint.HOOK, request=ASUSDATA_REQUEST["speedtest_history"]
# ),
AsusData.SPEEDTEST_RESULT: AsusData.SPEEDTEST,
# AsusData.SPEEDTEST_SERVERS: AsusDataFinder(
# Endpoint.HOOK, request=ASUSDATA_REQUEST["speedtest_servers"]
# ),
AsusData.SYSINFO: AsusDataFinder(Endpoint.SYSINFO),
AsusData.TEMPERATURE: AsusDataFinder(Endpoint.TEMPERATURE),
AsusData.VPNC: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["vpnc"],
request=ASUSDATA_REQUEST["vpnc"],
),
AsusData.VPNC_CLIENTLIST: AsusData.VPNC,
AsusData.WAN: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["wan"],
request=ASUSDATA_REQUEST["wan"],
),
AsusData.WIREGUARD: AsusData.WIREGUARD_SERVER,
AsusData.WIREGUARD_CLIENT: AsusData.VPNC,
AsusData.WIREGUARD_SERVER: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["wireguard_server"],
request=ASUSDATA_REQUEST["wireguard_server"],
),
AsusData.WLAN: AsusDataFinder(
Endpoint.HOOK,
method=wlan_nvram_request,
arguments=AsusRouterAttribute.WLAN_LIST,
),
AsusData.DSL: AsusDataFinder(
Endpoint.HOOK,
nvram=ASUSDATA_NVRAM["dsl"],
),
}
def add_conditional_data_rule(data: AsusData, rule: AsusDataFinder) -> None:
"""Add or change rule for ASUSDATA_MAP."""
ASUSDATA_MAP[data] = rule
_LOGGER.debug("Added conditional data rule: %s -> %s", data, rule)
def add_conditional_data_alias(data: AsusData, origin: AsusData) -> None:
"""Add or change rule for ASUSDATA_MAP."""
ASUSDATA_MAP[data] = origin
_LOGGER.debug("Added data alias: %s -> %s", origin, data)
def remove_data_rule(data: AsusData) -> None:
"""Remove rule for ASUSDATA_MAP."""
ASUSDATA_MAP.pop(data, None)
_LOGGER.debug("Removed data rule: %s", data)
|
