File: example.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 (242 lines) | stat: -rw-r--r-- 6,861 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
# Run with python3 example.py -h for help
"""aioshelly usage example."""

from __future__ import annotations

import argparse
import asyncio
import json
import logging
import traceback
from functools import partial
from pathlib import Path

from aiohttp import ClientSession
from common import (
    check_rpc_device_supports_scripts,
    close_connections,
    coap_context,
    connect_and_print_device,
    create_device,
    device_updated,
    init_device,
    print_device,
    update_outbound_ws,
    wait_for_keyboard_interrupt,
    ws_context,
)

from aioshelly.common import ConnectionOptions
from aioshelly.const import (
    BLOCK_GENERATIONS,
    DEFAULT_HTTP_PORT,
    RPC_GENERATIONS,
    WS_API_URL,
)


async def test_single(options: ConnectionOptions, init: bool, gen: int | None) -> None:
    """Test single device."""
    async with ClientSession() as aiohttp_session:
        device = await create_device(aiohttp_session, options, gen)

        if init and not await init_device(device):
            return

        print_device(device)

        device.subscribe_updates(partial(device_updated, action=print_device))

        await wait_for_keyboard_interrupt()

        await device.shutdown()
        close_connections()


async def test_devices(init: bool, gen: int | None) -> None:
    """Test multiple devices."""
    options: ConnectionOptions

    with Path.open(Path("devices.json"), encoding="utf8") as fp:
        device_options = [ConnectionOptions(**json.loads(line)) for line in fp]

    async with ClientSession() as aiohttp_session:
        results = await asyncio.gather(
            *[
                asyncio.gather(
                    connect_and_print_device(aiohttp_session, options, init, gen),
                )
                for options in device_options
            ],
            return_exceptions=True,
        )

        for options, result in zip(device_options, results, strict=False):
            if isinstance(result, bool) and not result:
                print(f"Error printing device @ {options.ip_address}:{options.port}")
            elif isinstance(result, Exception):
                print()
                traceback.print_tb(result.__traceback__)
                print(result)

        await wait_for_keyboard_interrupt()
        close_connections()


def get_arguments() -> tuple[argparse.ArgumentParser, argparse.Namespace]:
    """Get parsed passed in arguments."""
    parser = argparse.ArgumentParser(description="aioshelly example")
    parser.add_argument(
        "--ip_address", "-ip", type=str, help="Test single device by IP address"
    )
    parser.add_argument(
        "--device_port",
        "-dp",
        type=int,
        default=DEFAULT_HTTP_PORT,
        help="Port to use when testing single device",
    )
    parser.add_argument(
        "--coap_port",
        "-cp",
        type=int,
        default=5683,
        help="Specify CoAP UDP port (default=5683)",
    )
    parser.add_argument(
        "--ws_port",
        "-wp",
        type=int,
        default=8123,
        help="Specify WebSocket TCP port (default=8123)",
    )
    parser.add_argument(
        "--ws_api_url",
        "-au",
        type=str,
        default=WS_API_URL,
        help=f"Specify WebSocket API URL (default={WS_API_URL})",
    )
    parser.add_argument(
        "--devices",
        "-d",
        action="store_true",
        help=(
            'Connect to all the devices in "devices.json" '
            "at once and print their status"
        ),
    )
    parser.add_argument(
        "--init", "-i", action="store_true", help="Init device(s) at startup"
    )
    parser.add_argument("--username", "-u", type=str, help="Set device username")
    parser.add_argument("--password", "-p", type=str, help="Set device password")

    gen = parser.add_mutually_exclusive_group()
    gen.add_argument(
        "--gen1",
        "-g1",
        action="store_const",
        const=1,
        dest="gen",
        help="Force Gen1 (CoAP) device",
    )
    gen.add_argument(
        "--gen2",
        "-g2",
        action="store_const",
        const=2,
        dest="gen",
        help="Force Gen 2 (RPC) device",
    )
    gen.add_argument(
        "--gen3",
        "-g3",
        action="store_const",
        const=3,
        dest="gen",
        help="Force Gen 3 (RPC) device",
    )
    gen.add_argument(
        "--gen4",
        "-g4",
        action="store_const",
        const=4,
        dest="gen",
        help="Force Gen 4 (RPC) device",
    )

    parser.add_argument(
        "--debug", "-deb", action="store_true", help="Enable debug level for logging"
    )
    parser.add_argument(
        "--mac", "-m", type=str, help="Optional device MAC to subscribe for updates"
    )
    parser.add_argument(
        "--update_ws",
        "-uw",
        type=str,
        help="Update outbound WebSocket (for RPC device) and exit",
    )
    parser.add_argument(
        "--listen_ip_address",
        "-lip",
        type=str,
        nargs="*",
        default=None,
        help="Listen ip address for incoming CoAP packets",
    )
    parser.add_argument(
        "--supports_scripts",
        "-ss",
        action="store_true",
        help="Check if device supports scripts",
    )

    arguments = parser.parse_args()

    return parser, arguments


async def main() -> None:
    """Run main."""
    parser, args = get_arguments()

    await coap_context.initialize(args.coap_port, args.listen_ip_address)
    await ws_context.initialize(args.ws_port, args.ws_api_url)

    if not args.init and not args.gen:
        parser.error("specify gen if no device init at startup")

    if args.debug:
        logging.basicConfig(level=logging.DEBUG)
        # if gen is in args reduce logging for other gens
        if args.gen in BLOCK_GENERATIONS:
            logging.getLogger("aioshelly.rpc_device").setLevel(logging.INFO)
        elif args.gen in RPC_GENERATIONS:
            logging.getLogger("aioshelly.block_device").setLevel(logging.INFO)

    if args.devices:
        await test_devices(args.init, args.gen)
    elif args.ip_address:
        if args.username and args.password is None:
            parser.error("--username and --password must be used together")
        options = ConnectionOptions(
            args.ip_address,
            args.username,
            args.password,
            device_mac=args.mac,
            port=args.device_port,
        )
        if args.update_ws:
            await update_outbound_ws(options, args.init, args.update_ws)
        elif args.supports_scripts:
            await check_rpc_device_supports_scripts(options, args.gen)
        else:
            await test_single(options, args.init, args.gen)
    else:
        parser.error("--ip_address or --devices must be specified")


if __name__ == "__main__":
    asyncio.run(main())