File: cli.py

package info (click to toggle)
python-ttls 1.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 168 kB
  • sloc: python: 1,002; makefile: 7; sh: 5
file content (318 lines) | stat: -rw-r--r-- 9,843 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
"""
Twinkly Twinkly Little Star
https://github.com/jschlyter/ttls

Copyright (c) 2019 Jakob Schlyter. All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""

import argparse
import asyncio
import json
import logging
import re
import sys

from .client import (
    TWINKLY_MODES,
    TWINKLY_MUSIC_DRIVERS,
    TWINKLY_MUSIC_DRIVERS_OFFICIAL,
    TWINKLY_MUSIC_DRIVERS_UNOFFICIAL,
    Twinkly,
)
from .colours import TwinklyColour

logger = logging.getLogger(__name__)


async def command_name(t: Twinkly, args: argparse.Namespace):
    if args.name is None:
        return await t.get_name()
    return await t.set_name(args.name)


async def command_network(t: Twinkly, args: argparse.Namespace):
    return await t.get_network_status()


async def command_firmware(t: Twinkly, args: argparse.Namespace):
    return await t.get_firmware_version()


async def command_details(t: Twinkly, args: argparse.Namespace):
    return await t.get_details()


async def command_power(t: Twinkly, args: argparse.Namespace):
    if args.on:
        return await t.turn_on()
    elif args.off:
        return await t.turn_off()
    else:
        on = await t.is_on()
        if on:
            return "on"
        else:
            return "off"


async def command_brightness(t: Twinkly, args: argparse.Namespace):
    if args.pct is None:
        return await t.get_brightness()
    return await t.set_brightness(args.pct)


async def command_mode(t: Twinkly, args: argparse.Namespace):
    if args.mode is None:
        return await t.get_mode()
    return await t.set_mode(args.mode)


async def command_mqtt(t: Twinkly, args: argparse.Namespace):
    if args.mqtt_json is None:
        return await t.get_mqtt()
    data = json.loads(args.mqtt_json)
    return await t.set_mqtt(data)


async def command_movie(t: Twinkly, args: argparse.Namespace):
    if args.movie_file is None:
        return await t.get_movie_config()
    with open(args.movie_file, "rb") as f:
        movie = f.read()
    await t.interview()
    params = {
        "frame_delay": args.movie_delay,
        "leds_number": t.length,
        "frames_number": int(len(movie) / 3 / t.length),
    }
    await t.set_mode("movie")
    await t.set_movie_config(params)
    return await t.upload_movie(movie)


async def command_static(t: Twinkly, args: argparse.Namespace):
    await t.interview()
    # match on r,g,b or r,g,b,w
    if m := re.match(r"(\d+),(\d+),(\d+)(?:,(\d+))?", args.colour):
        r = int(m.group(1))
        g = int(m.group(2))
        b = int(m.group(3))
        # w is optional; convert to int if set
        if w := m.group(4):
            w = int(w)
        c = TwinklyColour(r, g, b, w)
    else:
        raise ValueError("Colour argument is not in r,g,b or r,g,b,w format")
    return await t.set_static_colour(c)


async def command_summary(t: Twinkly, args: argparse.Namespace):
    return await t.summary()


async def command_music(t: Twinkly, args: argparse.Namespace):
    if args.on:
        return await t.music_on()
    elif args.off:
        return await t.music_off()
    elif args.next:
        return await t.next_music_driver()
    elif args.prev:
        return await t.previous_music_driver()
    elif args.current:
        return await t.get_current_music_driver()
    elif args.driver:
        return await t.set_current_music_driver(args.driver)
    elif args.list:
        if args.list == "all":
            return TWINKLY_MUSIC_DRIVERS
        elif args.list == "official":
            return TWINKLY_MUSIC_DRIVERS_OFFICIAL
        elif args.list == "unofficial":
            return TWINKLY_MUSIC_DRIVERS_UNOFFICIAL


async def main_loop() -> None:
    """Main function"""

    parser = argparse.ArgumentParser(description="Twinkly Twinkly Little Star")
    parser.add_argument("--host", metavar="hostname", required=True, help="Device address")
    parser.add_argument("--debug", action="store_true", help="Enable debugging")
    parser.add_argument("--json", action="store_true", help="Output result as compact JSON")

    subparsers = parser.add_subparsers(dest="command")

    parser_network = subparsers.add_parser("network", help="Get network status")
    parser_network.set_defaults(func=command_network)

    parser_firmware = subparsers.add_parser("firmware", help="Get firmware version")
    parser_firmware.set_defaults(func=command_firmware)

    parser_details = subparsers.add_parser("details", help="Get device details")
    parser_details.set_defaults(func=command_details)

    parser_name = subparsers.add_parser("name", help="Get or set device name")
    parser_name.add_argument("--name", metavar="name", type=str, required=False)
    parser_name.set_defaults(func=command_name)

    parser_power = subparsers.add_parser("power", help="Get or set device power state ('on', 'off')")
    parser_power.add_argument("--on", action="store_true", required=False, help="Turn device on")
    parser_power.add_argument("--off", action="store_true", required=False, help="Turn device off")
    parser_power.set_defaults(func=command_power)

    parser_brightness = subparsers.add_parser("brightness", help="Get or set LED brightness")
    parser_brightness.add_argument(
        "--pct",
        metavar="value",
        type=int,
        required=False,
        help="Percent brightness (1-100)",
    )
    parser_brightness.set_defaults(func=command_brightness)

    parser_mode = subparsers.add_parser("mode", help="Get or set LED operation mode")
    parser_mode.add_argument(
        "--mode",
        choices=TWINKLY_MODES,
        required=False,
    )
    parser_mode.set_defaults(func=command_mode)

    parser_mqtt = subparsers.add_parser("mqtt", help="Get or set MQTT configuration")
    parser_mqtt.add_argument(
        "--json",
        dest="mqtt_json",
        metavar="mqtt",
        type=str,
        required=False,
        help="MQTT config as JSON",
    )
    parser_mqtt.set_defaults(func=command_mqtt)

    parser_movie = subparsers.add_parser("movie", help="Movie configuration")
    parser_movie.add_argument(
        "--delay",
        dest="movie_delay",
        metavar="milliseconds",
        type=int,
        default=100,
        required=False,
        help="Delay between frames",
    )
    parser_movie.add_argument(
        "--file",
        dest="movie_file",
        metavar="filename",
        type=str,
        required=False,
        help="Movie file",
    )
    parser_movie.set_defaults(func=command_movie)

    parser_colour = subparsers.add_parser("static", help="Set static")
    parser_colour.add_argument(
        "--colour",
        dest="colour",
        metavar="colour",
        type=str,
        required=True,
        help="Colour",
    )
    parser_colour.set_defaults(func=command_static)

    parser_summary = subparsers.add_parser("summary", help="Get device summary")
    parser_summary.set_defaults(func=command_summary)

    parser_music = subparsers.add_parser("music", help="Twinkly Music device control")
    parser_music.add_argument(
        "--on",
        action="store_true",
        help="Turn on Twinkly Music",
    )
    parser_music.add_argument(
        "--off",
        action="store_true",
        help="Turn off Twinkly Music",
    )
    parser_music.add_argument(
        "--next",
        action="store_true",
        help="Select next official music driver",
    )
    parser_music.add_argument(
        "--prev",
        action="store_true",
        help="Select previous official music driver",
    )
    parser_music.add_argument(
        "--current",
        action="store_true",
        help="Get the current music driver",
    )
    parser_music.add_argument(
        "--driver",
        metavar="name",
        type=str,
        choices=list(TWINKLY_MUSIC_DRIVERS.keys()),
        help="Set a music driver",
    )
    parser_music.add_argument(
        "--list",
        metavar="type",
        choices=["all", "official", "unofficial"],
        nargs="?",
        const="all",
        help="List all, official, or unofficial music drivers (default: all)",
    )
    parser_music.set_defaults(func=command_music)

    args = parser.parse_args()

    if args.debug:
        logging.basicConfig(level=logging.DEBUG)

    t = Twinkly(host=args.host)

    try:
        res = await args.func(t, args)
    except AttributeError:
        parser.print_help()
        await t.close()
        sys.exit(0)

    if args.json:
        print(json.dumps(res, indent=None, separators=(",", ":")))
    else:
        if res is not None:
            print(json.dumps(res, indent=4))

    await t.close()


def main() -> None:
    asyncio.run(main_loop())


if __name__ == "__main__":
    main()