File: provisioning.py

package info (click to toggle)
python-aioshelly 13.17.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 732 kB
  • sloc: python: 6,867; makefile: 7; sh: 3
file content (90 lines) | stat: -rw-r--r-- 2,406 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
"""WiFi provisioning via BLE for Shelly devices."""

from __future__ import annotations

from contextlib import asynccontextmanager
from typing import TYPE_CHECKING, Any, cast

from ..common import ConnectionOptions
from ..rpc_device import RpcDevice

if TYPE_CHECKING:
    from collections.abc import AsyncIterator

    from bleak.backends.device import BLEDevice


@asynccontextmanager
async def ble_rpc_device(ble_device: BLEDevice) -> AsyncIterator[RpcDevice]:
    """Create and manage BLE RPC device connection.

    Args:
        ble_device: BLE device to connect to

    Yields:
        Initialized RPC device

    Raises:
        DeviceConnectionError: If connection to device fails

    """
    options = ConnectionOptions(ble_device=ble_device)
    device = await RpcDevice.create(
        aiohttp_session=None,
        ws_context=None,
        ip_or_options=options,
    )

    try:
        await device.initialize()
        yield device
    finally:
        await device.shutdown()


async def async_scan_wifi_networks(ble_device: BLEDevice) -> list[dict[str, Any]]:
    """Scan for WiFi networks via BLE.

    Args:
        ble_device: BLE device to connect to

    Returns:
        List of WiFi networks with ssid, rssi, auth fields

    Raises:
        DeviceConnectionError: If connection to device fails
        RpcCallError: If RPC call fails

    """
    async with ble_rpc_device(ble_device) as device:
        # WiFi scan can take up to 20 seconds - use 30s timeout to be safe
        scan_result = await device.call_rpc("WiFi.Scan", timeout=30)
        return cast(list[dict[str, Any]], scan_result.get("results", []))


async def async_provision_wifi(ble_device: BLEDevice, ssid: str, password: str) -> None:
    """Provision WiFi credentials to device via BLE.

    Args:
        ble_device: BLE device to connect to
        ssid: WiFi network SSID
        password: WiFi network password

    Raises:
        DeviceConnectionError: If connection to device fails
        RpcCallError: If RPC call fails

    """
    async with ble_rpc_device(ble_device) as device:
        await device.call_rpc(
            "WiFi.SetConfig",
            {
                "config": {
                    "sta": {
                        "ssid": ssid,
                        "pass": password,
                        "enable": True,
                    }
                }
            },
        )