broadlink-async 1.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,341 @@
1
+ """The broadlink-async library."""
2
+
3
+ import contextlib
4
+ from collections.abc import AsyncGenerator
5
+
6
+ from . import exceptions as e
7
+ from .alarm import S1C
8
+ from .climate import hvac, hysen
9
+ from .const import DEFAULT_BCAST_ADDR, DEFAULT_PORT, DEFAULT_TIMEOUT
10
+ from .cover import dooya, dooya2, wser
11
+ from .device import Device, ping, scan, send_setup_packet
12
+ from .hub import s3
13
+ from .light import lb1, lb2
14
+ from .remote import rm, rm4, rm4mini, rm4pro, rm5plus, rmmini, rmminib, rmpro
15
+ from .sensor import a1, a2
16
+ from .switch import bg1, ehc31, mp1, mp1s, sp1, sp2, sp2s, sp3, sp3s, sp4, sp4b
17
+
18
+ SUPPORTED_TYPES = {
19
+ sp1: {
20
+ 0x0000: ("SP1", "Broadlink"),
21
+ },
22
+ sp2: {
23
+ 0x2717: ("NEO", "Ankuoo"),
24
+ 0x2719: ("SP2-compatible", "Honeywell"),
25
+ 0x271A: ("SP2-compatible", "Honeywell"),
26
+ 0x2720: ("SP mini", "Broadlink"),
27
+ 0x2728: ("SP2-compatible", "URANT"),
28
+ 0x273E: ("SP mini", "Broadlink"),
29
+ 0x7530: ("SP2", "Broadlink (OEM)"),
30
+ 0x7539: ("SP2-IL", "Broadlink (OEM)"),
31
+ 0x753E: ("SP mini 3", "Broadlink"),
32
+ 0x7540: ("MP2", "Broadlink"),
33
+ 0x7544: ("SP2-CL", "Broadlink"),
34
+ 0x7546: ("SP2-UK/BR/IN", "Broadlink (OEM)"),
35
+ 0x7547: ("SC1", "Broadlink"),
36
+ 0x7549: ("SP mini 3", "Broadlink (OEM)"),
37
+ 0x7918: ("SP2", "Broadlink (OEM)"),
38
+ 0x7919: ("SP2-compatible", "Honeywell"),
39
+ 0x791A: ("SP2-compatible", "Honeywell"),
40
+ 0x7D0D: ("SP mini 3", "Broadlink (OEM)"),
41
+ },
42
+ sp2s: {
43
+ 0x2711: ("SP2", "Broadlink"),
44
+ 0x2716: ("NEO PRO", "Ankuoo"),
45
+ 0x271D: ("Ego", "Efergy"),
46
+ 0x2736: ("SP mini+", "Broadlink"),
47
+ },
48
+ sp3: {
49
+ 0x2733: ("SP3", "Broadlink"),
50
+ 0x7D00: ("SP3-EU", "Broadlink (OEM)"),
51
+ },
52
+ sp3s: {
53
+ 0x9479: ("SP3S-US", "Broadlink"),
54
+ 0x947A: ("SP3S-EU", "Broadlink"),
55
+ },
56
+ sp4: {
57
+ 0x7568: ("SP4L-CN", "Broadlink"),
58
+ 0x756B: ("SP4M-JP", "Broadlink"),
59
+ 0x756C: ("SP4M", "Broadlink"),
60
+ 0x756F: ("MCB1", "Broadlink"),
61
+ 0x7579: ("SP4L-EU", "Broadlink"),
62
+ 0x757B: ("SP4L-AU", "Broadlink"),
63
+ 0x7583: ("SP mini 3", "Broadlink"),
64
+ 0x7587: ("SP4L-UK", "Broadlink"),
65
+ 0x7D11: ("SP mini 3", "Broadlink"),
66
+ 0x7D15: ("SP mini 3-AL", "Broadlink (OEM)"),
67
+ 0xA4F9: ("WS4", "Broadlink (OEM)"),
68
+ 0xA569: ("SP4L-UK", "Broadlink"),
69
+ 0xA56A: ("MCB1", "Broadlink"),
70
+ 0xA56B: ("SCB1E", "Broadlink"),
71
+ 0xA56C: ("SP4L-EU", "Broadlink"),
72
+ 0xA576: ("SP4L-AU", "Broadlink"),
73
+ 0xA589: ("SP4L-UK", "Broadlink"),
74
+ 0xA5D3: ("SP4L-EU", "Broadlink"),
75
+ 0xA57A: ("SP4", "Broadlink"),
76
+ 0xA6F4: ("SP4D-US", "Broadlink"),
77
+ },
78
+ sp4b: {
79
+ 0x5115: ("SCB1E", "Broadlink"),
80
+ 0x51E2: ("AHC/U-01", "BG Electrical"),
81
+ 0x6111: ("MCB1", "Broadlink"),
82
+ 0x6113: ("SCB1E", "Broadlink"),
83
+ 0x618B: ("SP4L-EU", "Broadlink"),
84
+ 0x6489: ("SP4L-AU", "Broadlink"),
85
+ 0x648B: ("SP4M-US", "Broadlink"),
86
+ 0x648C: ("SP4L-US", "Broadlink"),
87
+ 0x6494: ("SCB2", "Broadlink"),
88
+ },
89
+ rmmini: {
90
+ 0x2737: ("RM mini 3", "Broadlink"),
91
+ 0x278F: ("RM mini", "Broadlink"),
92
+ 0x27B7: ("RM mini 3", "Broadlink"),
93
+ 0x27C2: ("RM mini 3", "Broadlink"),
94
+ 0x27C7: ("RM mini 3", "Broadlink"),
95
+ 0x27C8: ("RM mini 3", "Broadlink"), # CMCC version
96
+ 0x27CC: ("RM mini 3", "Broadlink"),
97
+ 0x27CD: ("RM mini 3", "Broadlink"),
98
+ 0x27D0: ("RM mini 3", "Broadlink"),
99
+ 0x27D1: ("RM mini 3", "Broadlink"),
100
+ 0x27D3: ("RM mini 3", "Broadlink"),
101
+ 0x27DC: ("RM mini 3", "Broadlink"),
102
+ 0x27DE: ("RM mini 3", "Broadlink"),
103
+ 0xA544: ("RM mini 3", "Broadlink (OEM)"),
104
+ },
105
+ rmpro: {
106
+ 0x2712: ("RM pro/pro+", "Broadlink"),
107
+ 0x272A: ("RM pro", "Broadlink"),
108
+ 0x273D: ("RM pro", "Broadlink"),
109
+ 0x277C: ("RM home", "Broadlink"),
110
+ 0x2783: ("RM home", "Broadlink"),
111
+ 0x2787: ("RM pro", "Broadlink"),
112
+ 0x278B: ("RM plus", "Broadlink"),
113
+ 0x2797: ("RM pro+", "Broadlink"),
114
+ 0x279D: ("RM pro+", "Broadlink"),
115
+ 0x27A1: ("RM plus", "Broadlink"),
116
+ 0x27A6: ("RM plus", "Broadlink"),
117
+ 0x27A9: ("RM pro+", "Broadlink"),
118
+ 0x27C3: ("RM pro+", "Broadlink"),
119
+ # Mapping follows the diff in upstream #838 (its text says rm4pro,
120
+ # its diff says rmpro). Testers in that thread reported the device
121
+ # answering "locked" on auth, so treat it as reported, not confirmed.
122
+ 0xAF8B: ("RM Max", "Broadlink"),
123
+ },
124
+ rmminib: {
125
+ 0x5F36: ("RM mini 3", "Broadlink"),
126
+ 0x6507: ("RM mini 3", "Broadlink"),
127
+ 0x6508: ("RM mini 3", "Broadlink"),
128
+ },
129
+ rm4mini: {
130
+ 0x51DA: ("RM4 mini", "Broadlink"),
131
+ 0x5209: ("RM4 TV mate", "Broadlink"),
132
+ 0x520C: ("RM4 mini", "Broadlink"),
133
+ 0x520D: ("RM4C mini", "Broadlink"),
134
+ 0x5211: ("RM4C mate", "Broadlink"),
135
+ 0x5212: ("RM4 TV mate", "Broadlink"),
136
+ 0x5216: ("RM4 mini", "Broadlink"),
137
+ 0x521C: ("RM4 mini", "Broadlink"),
138
+ 0x6070: ("RM4C mini", "Broadlink"),
139
+ 0x610E: ("RM4 mini", "Broadlink"),
140
+ 0x610F: ("RM4C mini", "Broadlink"),
141
+ 0x62BC: ("RM4 mini", "Broadlink"),
142
+ 0x62BE: ("RM4C mini", "Broadlink"),
143
+ 0x6364: ("RM4S", "Broadlink"),
144
+ 0x648D: ("RM4 mini", "Broadlink"),
145
+ 0x6539: ("RM4C mini", "Broadlink"),
146
+ 0x653A: ("RM4 mini", "Broadlink"),
147
+ },
148
+ rm4pro: {
149
+ 0x520B: ("RM4 pro", "Broadlink"),
150
+ 0x5213: ("RM4 pro", "Broadlink"),
151
+ 0x5218: ("RM4C pro", "Broadlink"),
152
+ 0x6026: ("RM4 pro", "Broadlink"),
153
+ 0x6184: ("RM4C pro", "Broadlink"),
154
+ 0x61A2: ("RM4 pro", "Broadlink"),
155
+ 0x649B: ("RM4 pro", "Broadlink"),
156
+ 0x653C: ("RM4 pro", "Broadlink"),
157
+ },
158
+ rm5plus: {
159
+ 0x5224: ("RM5 plus", "Broadlink"),
160
+ },
161
+ a1: {
162
+ 0x2714: ("A1", "Broadlink"),
163
+ },
164
+ a2: {
165
+ 0x4F60: ("A2", "Broadlink"),
166
+ },
167
+ mp1: {
168
+ 0x4EB5: ("MP1-1K4S", "Broadlink"),
169
+ 0x4EDA: ("MP1-1K3S2U", "Broadlink"),
170
+ 0x4F1B: ("MP1-1K3S2U", "Broadlink (OEM)"),
171
+ 0x4F65: ("MP1-1K3S2U", "Broadlink"),
172
+ },
173
+ mp1s: {
174
+ 0x4EF7: ("MP1-1K4S", "Broadlink (OEM)"),
175
+ },
176
+ lb1: {
177
+ 0x5043: ("SB800TD", "Broadlink (OEM)"),
178
+ 0x504E: ("LB1", "Broadlink"),
179
+ 0x606D: ("SLA22RGB9W81/SLA27RGB9W81", "Luceco"),
180
+ 0x606E: ("SB500TD", "Broadlink (OEM)"),
181
+ 0x60C7: ("LB1", "Broadlink"),
182
+ 0x60C8: ("LB1", "Broadlink"),
183
+ 0x6112: ("LB1", "Broadlink"),
184
+ 0x644B: ("LB1", "Broadlink"),
185
+ 0x644C: ("LB27 R1", "Broadlink"),
186
+ 0x644E: ("LB26 R1", "Broadlink"),
187
+ 0x6488: ("LB27 C1", "Broadlink"),
188
+ 0x6498: ("SMART+ WIFI CEILING TW 24W", "LEDVANCE"),
189
+ },
190
+ lb2: {
191
+ 0xA4F4: ("LB27 R1", "Broadlink"),
192
+ 0xA5F7: ("LB27 R1", "Broadlink"),
193
+ 0xA6EF: ("EFCF60WSMT", "Luceco"),
194
+ 0xA517: ("LB26 R1", "Broadlink"),
195
+ },
196
+ S1C: {
197
+ 0x2722: ("S2KIT", "Broadlink"),
198
+ },
199
+ s3: {
200
+ 0xA59C: ("S3", "Broadlink"),
201
+ 0xA64D: ("S3", "Broadlink"),
202
+ },
203
+ hvac: {
204
+ 0x4E2A: ("HVAC", "Licensed manufacturer"),
205
+ },
206
+ hysen: {
207
+ 0x4EAD: ("HY02/HY03", "Hysen"),
208
+ },
209
+ dooya: {
210
+ 0x4E4D: ("DT360E-45/20", "Dooya"),
211
+ },
212
+ dooya2: {
213
+ 0x4F6E: ("DT360E-45/20", "Dooya"),
214
+ },
215
+ wser: {
216
+ 0x4F6C: ("WSER", "Wistar"),
217
+ },
218
+ bg1: {
219
+ 0x51E3: ("BG800/BG900", "BG Electrical"),
220
+ },
221
+ ehc31: {
222
+ 0x6480: ("EHC31", "BG Electrical"),
223
+ },
224
+ }
225
+
226
+
227
+ def gendevice(
228
+ dev_type: int,
229
+ host: tuple[str, int],
230
+ mac: bytes | str,
231
+ name: str = "",
232
+ is_locked: bool = False,
233
+ ) -> Device:
234
+ """Generate a device."""
235
+ for dev_cls, products in SUPPORTED_TYPES.items():
236
+ try:
237
+ model, manufacturer = products[dev_type]
238
+
239
+ except KeyError:
240
+ continue
241
+
242
+ return dev_cls(
243
+ host,
244
+ mac,
245
+ dev_type,
246
+ name=name,
247
+ model=model,
248
+ manufacturer=manufacturer,
249
+ is_locked=is_locked,
250
+ )
251
+
252
+ return Device(host, mac, dev_type, name=name, is_locked=is_locked)
253
+
254
+
255
+ async def hello(
256
+ ip_address: str,
257
+ port: int = DEFAULT_PORT,
258
+ timeout: float = DEFAULT_TIMEOUT,
259
+ ) -> Device:
260
+ """Direct device discovery.
261
+
262
+ Useful if the device is locked.
263
+ """
264
+ async with contextlib.aclosing(
265
+ xdiscover(
266
+ timeout=timeout,
267
+ discover_ip_address=ip_address,
268
+ discover_ip_port=port,
269
+ )
270
+ ) as devices:
271
+ async for device in devices:
272
+ return device
273
+ raise e.NetworkTimeoutError(
274
+ -4000,
275
+ "Network timeout",
276
+ f"No response received within {timeout}s",
277
+ )
278
+
279
+
280
+ async def discover(
281
+ timeout: float = DEFAULT_TIMEOUT,
282
+ local_ip_address: str | None = None,
283
+ discover_ip_address: str = DEFAULT_BCAST_ADDR,
284
+ discover_ip_port: int = DEFAULT_PORT,
285
+ ) -> list[Device]:
286
+ """Discover devices connected to the local network."""
287
+ devices = xdiscover(timeout, local_ip_address, discover_ip_address, discover_ip_port)
288
+ async with contextlib.aclosing(devices):
289
+ return [device async for device in devices]
290
+
291
+
292
+ async def xdiscover(
293
+ timeout: float = DEFAULT_TIMEOUT,
294
+ local_ip_address: str | None = None,
295
+ discover_ip_address: str = DEFAULT_BCAST_ADDR,
296
+ discover_ip_port: int = DEFAULT_PORT,
297
+ ) -> AsyncGenerator[Device]:
298
+ """Discover devices connected to the local network.
299
+
300
+ Yields each device as soon as it answers.
301
+ """
302
+ responses = scan(timeout, local_ip_address, discover_ip_address, discover_ip_port)
303
+ async with contextlib.aclosing(responses):
304
+ async for resp in responses:
305
+ yield gendevice(*resp)
306
+
307
+
308
+ # Setup a new Broadlink device via AP Mode. Review the README to see how to enter AP Mode.
309
+ # Only tested with Broadlink RM3 Mini (Blackbean)
310
+ async def setup(
311
+ ssid: str,
312
+ password: str,
313
+ security_mode: int,
314
+ ip_address: str = DEFAULT_BCAST_ADDR,
315
+ ) -> None:
316
+ """Set up a new Broadlink device via AP mode."""
317
+ # Security mode options are (0 - none, 1 = WEP, 2 = WPA1, 3 = WPA2, 4 = WPA1/2)
318
+ payload = bytearray(0x88)
319
+ payload[0x26] = 0x14 # This seems to always be set to 14
320
+ # Add the SSID to the payload
321
+ ssid_start = 68
322
+ ssid_length = 0
323
+ for letter in ssid:
324
+ payload[(ssid_start + ssid_length)] = ord(letter)
325
+ ssid_length += 1
326
+ # Add the WiFi password to the payload
327
+ pass_start = 100
328
+ pass_length = 0
329
+ for letter in password:
330
+ payload[(pass_start + pass_length)] = ord(letter)
331
+ pass_length += 1
332
+
333
+ payload[0x84] = ssid_length # Character length of SSID
334
+ payload[0x85] = pass_length # Character length of password
335
+ payload[0x86] = security_mode # Type of encryption
336
+
337
+ checksum = sum(payload, 0xBEAF) & 0xFFFF
338
+ payload[0x20] = checksum & 0xFF # Checksum 1 position
339
+ payload[0x21] = checksum >> 8 # Checksum 2 position
340
+
341
+ await send_setup_packet(bytes(payload), ip_address)
@@ -0,0 +1,44 @@
1
+ """Support for alarm kits."""
2
+
3
+ from . import exceptions as e
4
+ from .device import Device
5
+
6
+
7
+ class S1C(Device):
8
+ """Controls a Broadlink S1C."""
9
+
10
+ TYPE = "S1C"
11
+
12
+ _SENSORS_TYPES = {
13
+ 0x31: "Door Sensor",
14
+ 0x91: "Key Fob",
15
+ 0x21: "Motion Sensor",
16
+ }
17
+
18
+ async def get_sensors_status(self) -> dict:
19
+ """Return the state of the sensors."""
20
+ packet = bytearray(16)
21
+ packet[0] = 0x06
22
+ response = await self.send_packet(0x6A, packet)
23
+ e.check_error(response[0x22:0x24])
24
+ payload = self.decrypt(response[0x38:])
25
+ count = payload[0x4]
26
+ sensor_data = payload[0x6:]
27
+ sensors = [
28
+ bytearray(sensor_data[i * 83 : (i + 1) * 83])
29
+ for i in range(len(sensor_data) // 83)
30
+ ]
31
+ return {
32
+ "count": count,
33
+ "sensors": [
34
+ {
35
+ "status": sensor[0],
36
+ "name": sensor[4:26].decode().strip("\x00"),
37
+ "type": self._SENSORS_TYPES.get(sensor[3], "Unknown"),
38
+ "order": sensor[1],
39
+ "serial": sensor[26:30].hex(),
40
+ }
41
+ for sensor in sensors
42
+ if any(sensor[26:30])
43
+ ],
44
+ }