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 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
|
# vim:sw=4:ts=4:et
# Many thanks to @troopermax <https://github.com/troopermax>
"""Python Ring command line interface."""
from __future__ import annotations
import asyncio
import functools
import getpass
import json
import logging
import select
import sys
from contextlib import asynccontextmanager
from datetime import datetime
from pathlib import Path, PurePath
from typing import Sequence, cast, TypeVar, NoReturn
import asyncclick as click
from ring_doorbell import (
Auth,
AuthenticationError,
Requires2FAError,
Ring,
RingDoorBell,
RingEvent,
RingGeneric,
RingStickUpCam,
RingOther,
RingCapability,
)
from ring_doorbell.const import (
CLI_TOKEN_FILE,
GCM_TOKEN_FILE,
PACKAGE_NAME,
USER_AGENT,
DOORBELL_EXISTING_TYPE,
)
def _header() -> None:
_bar()
echo("Ring CLI")
def _bar() -> None:
echo("---------------------------------")
def error(msg: str) -> NoReturn:
"""Print an error and exit."""
echo(msg)
sys.exit(1)
click.anyio_backend = "asyncio" # type: ignore[attr-defined]
pass_ring = click.make_pass_decorator(Ring)
pass_doorbell = click.make_pass_decorator(RingDoorBell)
cache_file = Path(CLI_TOKEN_FILE)
gcm_cache_file = Path(GCM_TOKEN_FILE)
def CatchAllExceptions(cls):
"""Capture all exceptions and prints them nicely.
Idea from https://stackoverflow.com/a/44347763 and
https://stackoverflow.com/questions/52213375
"""
def _handle_exception(debug, exc):
if isinstance(exc, click.ClickException):
raise
# Handle exit request from click.
if isinstance(exc, click.exceptions.Exit):
sys.exit(exc.exit_code)
echo(f"Raised error: {exc}")
if debug:
raise
echo("Run with --debug enabled to see stacktrace")
sys.exit(1)
class _CommandCls(cls):
_debug = False
async def make_context(self, info_name, args, parent=None, **extra):
self._debug = any(
[arg for arg in args if arg in ["--debug", "-d", "--verbose", "-v"]]
)
try:
return await super().make_context(
info_name, args, parent=parent, **extra
)
except Exception as exc:
_handle_exception(self._debug, exc)
async def invoke(self, ctx):
try:
return await super().invoke(ctx)
except asyncio.CancelledError:
pass
except KeyboardInterrupt:
echo("Cli interrupted with keyboard interrupt")
except Exception as exc:
_handle_exception(self._debug, exc)
return _CommandCls
class MutuallyExclusiveOption(click.Option):
"""Prevents incompatable options being supplied, i.e. on and off."""
def __init__(self, *args, **kwargs) -> None:
self.mutually_exclusive = set(kwargs.pop("mutually_exclusive", []))
_help = kwargs.get("help", "")
if self.mutually_exclusive:
ex_str = ", ".join(self.mutually_exclusive)
kwargs["help"] = _help + (
" NOTE: This argument is mutually exclusive with "
" arguments: [" + ex_str + "]."
)
super().__init__(*args, **kwargs)
async def handle_parse_result(self, ctx, opts, args):
if self.mutually_exclusive.intersection(opts) and self.name in opts:
msg = (
"Illegal usage: `{}` is mutually exclusive with "
"arguments `{}`.".format(self.name, ", ".join(self.mutually_exclusive))
)
raise click.UsageError(msg)
return await super().handle_parse_result(ctx, opts, args)
echo = click.echo
def token_updated(token) -> None:
"""Writes token to file."""
cache_file.write_text(json.dumps(token), encoding="utf-8")
def _format_filename(device_name, event):
if not isinstance(event, dict):
return None
answered_status = "answered" if event["answered"] else "not_answered"
filename = "{}_{}_{}_{}_{}".format(
device_name, event["created_at"], event["kind"], answered_status, event["id"]
)
return filename.replace(" ", "_").replace(":", ".") + ".mp4"
async def _do_auth(username, password, user_agent=USER_AGENT):
if not username:
username = input("Username: ")
if not password:
password = getpass.getpass("Password: ")
auth = Auth(user_agent, None, token_updated)
try:
await auth.async_fetch_token(username, password)
return auth
except Requires2FAError:
await auth.async_fetch_token(username, password, input("2FA Code: "))
return auth
async def _get_ring(username, password, do_update_data, user_agent=USER_AGENT):
# connect to Ring account
global cache_file, gcm_cache_file
if user_agent != USER_AGENT:
cache_file = Path(user_agent + ".token.cache")
gcm_cache_file = Path(user_agent + ".gcm_token.cache")
if cache_file.is_file():
auth = Auth(
user_agent,
json.loads(cache_file.read_text(encoding="utf-8")),
token_updated,
)
ring = Ring(auth)
do_method = (
ring.async_update_data if do_update_data else ring.async_create_session
)
try:
await do_method()
except AuthenticationError:
auth = await _do_auth(username, password)
ring = Ring(auth)
do_method = (
ring.async_update_data if do_update_data else ring.async_create_session
)
await do_method()
else:
auth = await _do_auth(username, password, user_agent=user_agent)
ring = Ring(auth)
do_method = (
ring.async_update_data if do_update_data else ring.async_create_session
)
await do_method()
return ring
_T = TypeVar("_T")
def _get_device(
ring: Ring,
device_families: list[str],
device_type: type[_T],
device_name: str | None = None,
*,
device_description: str | None = None,
) -> _T:
description = (
device_description if device_description else " or ".join(device_families)
)
if not device_name:
dev_dict: dict[int, RingGeneric] = {}
devices = ring.devices()
for device_family in device_families:
for dev in devices[device_family]:
dev_dict[dev.device_api_id] = dev
devs = list(dev_dict.values())
found = len(dev_dict)
if found == 1:
return cast(_T, devs[0])
elif found == 0:
error(f"No {description} found")
else:
error(
f"There are {found} {description}s, you need to pass the --device-name option."
)
elif device := ring.get_device_by_name(device_name):
if device.family in device_families and isinstance(device, device_type):
return device
else:
error(f"{device_name} is not a {description}")
else:
error(f"Cannot find {description} with name {device_name}")
@click.group(
invoke_without_command=True,
cls=CatchAllExceptions(click.Group),
)
@click.version_option(package_name="ring_doorbell")
@click.option(
"--username",
default=None,
required=False,
envvar="RING_USERNAME",
help="Username for Ring account.",
)
@click.option(
"--password",
default=None,
required=False,
envvar="RING_PASSWORD",
help="Password for Ring account",
)
@click.option("-d", "--debug", default=False, is_flag=True)
@click.option(
"--user-agent",
default=USER_AGENT,
required=False,
envvar="RING_USER_AGENT",
help="User agent to send to ring",
)
@click.pass_context
async def cli(ctx, username, password, debug, user_agent):
"""Command line function."""
# no need to perform any checks if we are just displaying the help
if "--help" in sys.argv:
# Context object is required to avoid crashing on sub-groups
ctx.obj = Ring(None)
return
_header()
logging.basicConfig()
log_level = logging.DEBUG if debug else logging.INFO
logger = logging.getLogger(PACKAGE_NAME)
logger.setLevel(log_level)
logger = logging.getLogger("firebase_messaging")
logger.setLevel(log_level)
no_update_commands = ["listen"]
no_update = ctx.invoked_subcommand in no_update_commands
@asynccontextmanager
async def async_wrapped_ring(ring: Ring):
try:
yield ring
finally:
await ring.auth.async_close()
ring = await _get_ring(username, password, not no_update, user_agent)
# wrapped ring will ensure async_close is called when cli is finished
ctx.obj = await ctx.with_async_resource(async_wrapped_ring(ring))
if ctx.invoked_subcommand is None:
return await ctx.invoke(show)
return None
@cli.command(name="list")
@pass_ring
async def list_command(ring: Ring) -> None:
"""List ring devices."""
devices = ring.devices()
device: RingGeneric | None = None
for device in devices.doorbots:
echo(device)
for device in devices.authorized_doorbots:
echo(device)
for device in devices.chimes:
echo(device)
for device in devices.stickup_cams:
echo(device)
for device in devices.other:
echo(device)
@cli.command()
@pass_ring
@click.pass_context
@click.option(
"--on",
"turn_on",
cls=MutuallyExclusiveOption,
is_flag=True,
default=None,
required=False,
mutually_exclusive=["--off"],
)
@click.option(
"--off",
"turn_off",
cls=MutuallyExclusiveOption,
is_flag=True,
default=None,
required=False,
mutually_exclusive=["--on"],
)
@click.option(
"--device-name",
"-dn",
required=True,
default=None,
help="Name of the ring device",
)
async def motion_detection(ctx, ring: Ring, device_name, turn_on, turn_off):
"""Get and change the motion detecton status of a device."""
device = ring.get_device_by_name(device_name)
if not device:
echo(
f"No device with name {device_name} found."
+ " List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
if not device.has_capability("motion_detection"):
echo(f"{device!s} is not capable of motion detection")
return None
device = cast(RingDoorBell, device)
state = "on" if device.motion_detection else "off"
if not turn_on and not turn_off:
echo(f"{device!s} has motion detection {state}")
return None
is_on = device.motion_detection
if (turn_on and is_on) or (turn_off and not is_on):
echo(f"{device!s} already has motion detection {state}")
return None
await device.async_set_motion_detection(turn_on if turn_on else False)
await ring.async_update_devices()
state = "on" if device.motion_detection else "off"
echo(f"{device!s} motion detection set to {state}")
return None
@cli.command()
@pass_ring
@click.pass_context
@click.argument("enable", type=click.BOOL, default=None, required=False)
@click.option(
"--device-name",
"-dn",
required=True,
default=None,
help="Name of the ring device",
)
async def light(ctx, ring: Ring, device_name, enable):
"""Get and change the light state of a device."""
device = ring.get_device_by_name(device_name)
if not device:
echo(
f"No device with name {device_name} found."
+ " List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
if not device.has_capability(RingCapability.LIGHT):
echo(f"{device!s} does not have a light")
return None
device = cast(RingStickUpCam, device)
state = "on" if device.light else "off"
if enable is None:
echo(f"{device!s} light is {state}")
return None
is_on = device.light
if (enable and is_on) or (not enable and not is_on):
echo(f"{device!s} light is already {state}")
return None
await device.async_set_light(enable)
await ring.async_update_devices()
state = "on" if device.light else "off"
echo(f"{device!s} light set to {state}")
return None
@cli.command()
@click.option(
"--device-name",
"-dn",
required=False,
default=None,
help="Name of device, if ommited shows all devices",
)
@pass_ring
@click.pass_context
async def show(ctx, ring: Ring, device_name):
"""Display ring devices."""
devices: Sequence[RingGeneric] | None = None
if device_name and (device := ring.get_device_by_name(device_name)):
devices = [device]
elif device_name:
echo(
f"No device with name {device_name} found. "
+ "List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
else:
devices = ring.get_device_list()
for dev in devices:
await dev.async_update_health_data()
echo("Name: %s" % dev.name)
echo("Family: %s" % dev.family)
echo("ID: %s" % dev.id)
echo("Timezone: %s" % dev.timezone)
echo("Wifi Name: %s" % dev.wifi_name)
echo("Wifi RSSI: %s" % dev.wifi_signal_strength)
echo()
return None
@cli.command(name="devices")
@click.option(
"--device-name",
"-dn",
required=False,
default=None,
help="Name of device, if ommited shows all devices",
)
@click.option(
"--json",
"json_flag",
required=False,
is_flag=True,
help="Output raw json",
)
@pass_ring
@click.pass_context
async def devices_command(ctx, ring: Ring, device_name, json_flag):
"""Get device information."""
if not json_flag:
echo(
"(Pretty format coming soon, if you want json consistently "
+ "from this command provide the --json flag)"
)
device_json = None
if device_name and (device := ring.get_device_by_name(device_name)):
device_json = ring.devices_data[device.family][device.id]
elif device_name:
echo(
f"No device with name {device_name} found. "
+ "List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
if device_json:
echo(json.dumps(device_json, indent=2))
return None
else:
for device_type in ring.devices_data:
for device_api_id in ring.devices_data[device_type]:
echo(
json.dumps(ring.devices_data[device_type][device_api_id], indent=2)
)
return None
@cli.command()
@click.option(
"--json",
"json_flag",
required=False,
is_flag=True,
help="Output raw json",
)
@pass_ring
async def dings(ring: Ring, json_flag) -> None:
"""Get dings information."""
if not json_flag:
echo(
"(Pretty format coming soon, if you want json consistently "
+ "from this command provide the --json flag)"
)
echo(json.dumps(ring.dings_data, indent=2))
@cli.command()
@click.option(
"--json",
"json_flag",
required=False,
is_flag=True,
help="Output raw json",
)
@pass_ring
async def groups(ring: Ring, json_flag) -> None:
"""Get group information."""
if not json_flag:
echo(
"(Pretty format coming soon, if you want json consistently "
+ "from this command provide the --json flag)"
)
if not ring.groups_data:
echo("No ring device groups setup")
else:
for light_group in ring.groups().values():
await light_group.async_update()
echo(json.dumps(light_group._attrs, indent=2))
echo(json.dumps(light_group._health_attrs, indent=2))
@cli.command()
@click.option(
"--url",
required=True,
type=str,
help="Url to query, i.e. /clients_api/dings/active",
)
@pass_ring
async def raw_query(ring: Ring, url) -> None:
"""Directly query a url and return json result."""
resp = await ring.async_query(url)
data = resp.json()
echo(json.dumps(data, indent=2))
@cli.command(name="history")
@click.option(
"--device-name",
"-dn",
required=False,
default=None,
help="Name of device, if ommited shows all devices",
)
@click.option(
"--limit",
required=False,
default=5,
help="Limit number of records to return",
)
@click.option(
"--kind",
required=False,
default=None,
type=click.Choice(["ding", "motion", "on_demand"], case_sensitive=False),
help="Get devices",
)
@click.option(
"--json",
"json_flag",
required=False,
is_flag=True,
help="Output raw json",
)
@pass_ring
@click.pass_context
async def history_command(ctx, ring: Ring, device_name, kind, limit, json_flag):
"""Print raw json."""
if not json_flag:
echo(
"(Pretty format coming soon, if you want json consistently "
+ "from this command provide the --json flag)"
)
device = ring.get_device_by_name(device_name)
if not device:
echo(
f"No device with name {device_name} found. "
+ "List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
history = await device.async_history(limit=limit, kind=kind, convert_timezone=False)
echo(json.dumps(history, indent=2))
return None
@cli.command()
@click.option(
"--count",
required=False,
default=False,
is_flag=True,
help="Count the number of videos on your Ring account",
)
@click.option(
"--download-all",
required=False,
default=False,
is_flag=True,
help="Download all videos on your Ring account",
)
@click.option(
"--download",
required=False,
default=False,
is_flag=True,
help="Download videos on your Ring account up to the max-count option",
)
@click.option(
"--max-count",
required=False,
default=300,
help="Maximum count of videos to count or download from your Ring account",
)
@click.option(
"--download-to",
required=False,
default="./",
help="Download location ending with a /",
)
@click.option(
"--device-name",
"-dn",
default=None,
required=False,
help="Name of the ring device, if omitted uses the first device returned",
)
@pass_ring
@click.pass_context
async def videos(
ctx, ring: Ring, count, download, download_all, max_count, download_to, device_name
):
"""Interact with ring videos."""
device = None
if device_name and not (device := ring.get_video_device_by_name(device_name)):
echo(
f"No device with name {device_name} found. "
+ "List of found device names (kind) is:"
)
return await ctx.invoke(list_command)
if device and not device.has_capability("video"):
echo(f"Device {device.name} is not a video device")
return None
# return the first device is implemented to be consistent with previous cli version
if not device:
if video_devices := ring.video_devices():
device = video_devices[0]
else:
echo(
"No video devices found. "
+ "List of found device names (with device kind) is:"
)
return await ctx.invoke(list_command)
if not device: # Make mypy happy
return None
if (
not count
and not download
and not download_all
and (last_recording_id := await device.async_get_last_recording_id())
and (url := await device.async_recording_url(last_recording_id))
):
echo("Last recording url is: " + url)
return None
events = None
if download_all:
download = True
max_count = -1
async def _get_events(device, max_count):
limit = 100 if max_count == -1 else min(100, max_count)
events = []
history = await device.async_history(limit=limit)
while len(history) > 0:
events += history
if (len(events) >= max_count and max_count != -1) or len(history) < limit:
break
history = await device.async_history(
older_than=history[-1]["id"], limit=limit
)
return events
if count:
echo(
f"\tCounting videos linked on your Ring account for {device.name}.\n"
+ "\tThis may take some time....\n"
)
events = await _get_events(device, max_count)
motion = len([m["kind"] for m in events if m["kind"] == "motion"])
ding = len([m["kind"] for m in events if m["kind"] == "ding"])
on_demand = len([m["kind"] for m in events if m["kind"] == "on_demand"])
echo(f"\tTotal videos: {len(events)}")
echo(f"\tDing triggered: {ding}")
echo(f"\tMotion triggered: {motion}")
echo(f"\tOn-Demand triggered: {on_demand}")
if download:
if events is None:
echo(
"\tGetting videos linked on your Ring account.\n"
"\tThis may take some time....\n"
)
events = await _get_events(device, max_count)
echo(
f"\tDownloading {len(events)} videos linked on your Ring account.\n"
"\tThis may take some time....\n"
)
for counter, event in enumerate(events):
filename = str(PurePath(download_to, _format_filename(device.name, event)))
echo(f"\t{counter}/{len(events)} Downloading {filename}")
await device.async_recording_download(
event["id"], filename=filename, override=False
)
return None
return None
@cli.group(invoke_without_command=True)
@pass_ring
@click.pass_context
@click.option(
"--device-name",
"-dn",
required=False,
default=None,
help="Name of the ring device",
)
async def in_home_chime(ctx, ring: Ring, device_name):
"""View and manage the Doorbell in-home chime. To see the current in-home chime status of a device, only pass the device name."""
if "--help" in sys.argv:
return
device = _get_device(
ring,
["authorized_doorbots", "doorbots"],
RingDoorBell,
device_name,
device_description="doorbell",
)
if ctx.invoked_subcommand is None:
echo("Name: %s" % device.name)
echo("ID: %s" % device.id)
echo("Type: %s" % device.existing_doorbell_type)
echo("Enabled: %s" % device.existing_doorbell_type_enabled)
echo("Duration: %s" % device.existing_doorbell_type_duration)
return None
ctx.obj = device
@in_home_chime.command(name="type")
@pass_doorbell
@click.pass_context
@click.argument(
"new_type",
type=click.Choice(list(DOORBELL_EXISTING_TYPE.values()), case_sensitive=False),
default=None,
required=False,
)
async def in_home_chime_type(ctx, device: RingDoorBell, new_type):
"""Get/set the type of In-home chime."""
if new_type is None:
echo(device.existing_doorbell_type)
return
if device.family == "authorized_doorbots":
exit(
f"{device.name} is a shared device and you do not have permission to update this value"
)
new_type_int = next(k for k, v in DOORBELL_EXISTING_TYPE.items() if v == new_type)
await device.async_set_existing_doorbell_type(new_type_int)
echo(f"{device.name}'s in-home chime type has been set to {new_type}")
@in_home_chime.command()
@pass_doorbell
@click.pass_context
@click.argument("enable", type=click.BOOL, default=None, required=False)
async def enabled(ctx, device: RingDoorBell, enable: bool | None):
"""Gets/sets the in-home chime enabled status.
ENABLE: 1/0, true/false, t/f, yes/no, y/n, and on/off
"""
if enable is None:
echo(device.existing_doorbell_type_enabled)
return
if device.family == "authorized_doorbots":
exit(
f"{device.name} is a shared device and you do not have permission to update this value"
)
await device.async_set_existing_doorbell_type_enabled(enable)
echo(
f"{device.name}'s in-home chime has been {'enabled' if enable else 'disabled'}"
)
@in_home_chime.command()
@pass_doorbell
@click.pass_context
@click.argument("duration", type=click.IntRange(0, 100), default=None, required=False)
async def duration(ctx, device: RingDoorBell, duration: int | None):
"""Gets/sets the in-home chime duration.
DURATION: Value between 0 and 100
"""
if duration is None:
echo(device.existing_doorbell_type_duration)
return
if device.family == "authorized_doorbots":
exit(
f"{device.name} is a shared device and you do not have permission to update this value"
)
await device.async_set_existing_doorbell_type_duration(int(duration))
echo(f"{device.name}'s in-home chime duration has been set to {duration} seconds")
async def ainput(string: str):
loop = asyncio.get_event_loop()
await loop.run_in_executor(None, lambda s=string: sys.stdout.write(s + " ")) # type: ignore[misc]
return await loop.run_in_executor(None, sys.stdin.readline)
def get_now_str():
return str(datetime.utcnow())
class _event_handler: # pylint:disable=invalid-name
def __init__(self, ring: Ring) -> None:
self.ring = ring
def on_event(self, event: RingEvent) -> None:
msg = (
get_now_str()
+ ": "
+ str(event)
+ " : Currently active count = "
+ str(len(self.ring.push_dings_data))
)
echo(msg)
@cli.command
@click.option(
"--credentials-file",
required=False,
default=None,
help=(
"File to store push credentials, "
+ "if not provided credentials will be recreated from scratch"
),
)
@click.option(
"--store-credentials/--no-store-credentials",
default=True,
help="Whether or not to store the push credentials, default is false",
)
@click.option(
"--show-credentials",
default=False,
is_flag=True,
help="Whether or not to show the push credentials, default is false",
)
@pass_ring
@click.pass_context
async def listen(
ctx,
ring,
store_credentials,
credentials_file,
show_credentials,
) -> None:
"""Listen to push notification like the ones sent to your phone."""
from ring_doorbell.listen import ( # pylint:disable=import-outside-toplevel
RingEventListener,
)
def credentials_updated_callback(credentials) -> None:
if store_credentials:
with open(credentials_file, "w", encoding="utf-8") as f:
json.dump(credentials, f)
else:
echo("New push credentials created:")
if show_credentials:
echo(credentials)
if not credentials_file:
credentials_file = gcm_cache_file
else:
credentials_file = Path(credentials_file)
credentials = None
if store_credentials and credentials_file.is_file():
# already registered, load previous credentials
with open(credentials_file, encoding="utf-8") as f:
credentials = json.load(f)
event_listener = RingEventListener(ring, credentials, credentials_updated_callback)
await event_listener.start()
event_listener.add_notification_callback(_event_handler(ring).on_event)
await ainput("Listening, press enter to cancel\n")
await event_listener.stop()
@cli.command
@click.option(
"--device-name",
required=False,
default=None,
help=("Name of the intercom if there are more than one."),
)
@pass_ring
@click.pass_context
async def open_door(ctx, ring: Ring, device_name: str | None) -> None:
"""Open the door of a intercom device."""
device = _get_device(
ring,
["intercoms", "other"],
RingOther,
device_name,
device_description="intercom",
)
await device.async_open_door()
echo(f"{device.name} opened")
if __name__ == "__main__":
cli() # pylint: disable=no-value-for-parameter
|