Fix method to enable in-home doorbell chime by briangoldstein · Pull Request #419 · python-ring-doorbell/python-ring-doorbell

briangoldstein · 2024-08-30T14:30:16Z

I am currently working on adding code to the Home Assistant ring core component to support async_set_existing_doorbell_type and async_set_existing_doorbell_type_enabled. In working on the switch to enable/disable the in-home chime, I found that Ring is expecting a string, not a boolean value. Error below:

ring_doorbell.exceptions.RingError: Unknown error during query of url https://api.ring.com/clients_api/doorbots/: Invalid variable type: value should be str, int or float, got True of type <class 'bool'>

Ring is expecting 0 or 1 when enabling and disabling. I have tested the code change with a modified test.py with the following body between await ring.async_update_data() and await auth.async_close()

    # Fetch all available doorbells
    devices = ring.devices()
    doorbells=devices['doorbots']

    # Flip the status of the in-home chime for each doorbell
    for doorbell in list(doorbells):
        await doorbell.async_update_health_data()
        print()
        print()
        print('Address:    %s' % doorbell.address)
        print('Family:     %s' % doorbell.family)
        print('ID:         %s' % doorbell.id)
        print('Name:       %s' % doorbell.name)
        print('In-Home Chime Type: %s' % doorbell.existing_doorbell_type)
        print('In-Home Chime Status: %s' % doorbell.existing_doorbell_type_enabled)
        print()
        print()
        if doorbell.existing_doorbell_type_enabled:
            print('Turning Off In-Home Chime')
            await doorbell.async_set_existing_doorbell_type_enabled(0)
            time.sleep(5)  # Pause for 5 seconds
        else:
            print('Turning On In-Home Chime')
            await doorbell.async_set_existing_doorbell_type_enabled(1)
            time.sleep(5)  # Pause for 5 seconds
        print()
        print()
        print('In-Home Chime Type: %s' % doorbell.existing_doorbell_type)
        print('In-Home Chime Status: %s' % doorbell.existing_doorbell_type_enabled)

removing boolean message as only async_set_existing_doorbell_type_duration used it and is no longer needed.

gitguardian · 2024-08-30T14:30:51Z

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

Since your pull request originates from a forked repository, GitGuardian is not able to associate the secrets uncovered with secret incidents on your GitGuardian dashboard.
Skipping this check run and merging your pull request will create secret incidents on your GitGuardian dashboard.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
13592133	Triggered	Google API Key	`2d5d4cc`	ring_doorbell/const.py	View secret
13592133	Triggered	Google API Key	`82088d9`	ring_doorbell/const.py	View secret

🛠 Guidelines to remediate hardcoded secrets

Understand the implications of revoking this secret by investigating where it is used in your code.
Replace and store your secrets safely. Learn here the best practices.
Revoke and rotate these secrets.
If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

following these best practices for managing and storing secrets including API keys and other credentials
install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}

Blank lines added to summary/description text per ruff check.

sdb9696

As per comment please keep the public api unchanged.

Also please ensure you've done poetry install and run pre-commit to ensure the CI checks pass locally.

coveralls · 2024-08-30T18:01:31Z

coverage: 77.267% (-0.07%) from 77.334%
when pulling 1591eb1 on briangoldstein:master
into da5bd8c on tchellomello:master.

sdb9696 · 2024-08-30T18:06:32Z

I've never actually used these methods. What do they actually do? Can you actually set a doorbell type to manual or digital. Is this something available on all devices that derive from doorbots? i.e. stickup_cams etc.

briangoldstein · 2024-08-30T18:13:30Z

It's only available for (most) doorbell models. It lets the Ring doorbell trigger the in-home doorbell chime.

Not present = you don't have one (or want to use it)
Mechanical = the traditional ding dong physical bell
Digital = the fancy digital versions of doorbell chimes

For digital, you can also set the duration, but I do not have a digital in-home chime so I can't test that aspect and will leave it out of the home assistant changes I will submit.

I used to use a homebridge automation that would turn the in-home doorbell off during the day to prevent the dogs from going nuts, but then would have it turn on at night when our phones are on do not disturb or if we had someone watching the house.

https://ring.com/support/articles/vk1ml/configuring-your-doorbell-for-an-in-home-chime

sdb9696 · 2024-08-30T18:31:44Z

Ah ok that makes sense, very helpful thanks. So the doorbell doesn't actually know what kind of chime it's connected to? It has to be told in the app and the api?

briangoldstein · 2024-08-30T18:50:22Z

You're welcome! That is correct, this is what it looks like in the app when you set mechanical, digital, not present. I'll make sure to include some of this information when I submit the HA ring PR as well.

sdb9696 · 2024-08-30T18:55:33Z

Cool. So I think it would be good to have test coverage for this, especially if it's going to be enabled in HA.

briangoldstein · 2024-08-31T03:16:26Z

Sounds good. I am brand new to pytest, so will read up on it this weekend, but may take some time to implement.

briangoldstein · 2024-09-02T04:48:24Z

@sdb9696 I've added a test for the async_set_existing_doorbell_type_enabled function. Please let me know if you had additional tests in mind, thanks!

sdb9696 · 2024-09-02T10:23:54Z

Thanks for the PR @briangoldstein! N.B. I added some asserts and extra steps to the tests.

@briangoldstein

## [0.9.3](https://github.com/python-ring-doorbell/python-ring-doorbell/tree/0.9.3) (2024-09-02) [Full Changelog](0.9.2...0.9.3) **Release highlights:** - The python-ring-doorbell code repository has moved to https://github.com/python-ring-doorbell/python-ring-doorbell - Fix for enabling in-home chimes - Many thanks @briangoldstein! **Fixed bugs:** - Fix active listen alert counter [\#423](#423) (@sdb9696) - Fix method to enable in-home doorbell chime [\#419](#419) (@briangoldstein) **Documentation updates:** - Update supported python version in readme [\#422](#422) (@sdb9696) **Project maintenance:** - Migrate repo to python-ring-doorbell github organisation [\#421](#421) (@sdb9696) - Remove anyio from dependencies [\#420](#420) (@dotlambda)

sdb9696 · 2024-09-02T14:30:15Z

So that's now been released and should be bumped in HA once HA 125087 is merged. Feel free to hmu on discord (sdb9696) if you want to chat about how best to implement support for this in HA.

briangoldstein added 4 commits August 30, 2024 07:17

Changing existing_doorbell_type_enabled from bool to int

82088d9

Merge branch 'tchellomello:master' into master

bd37102

replacing with latest const.py from main repo

2d5d4cc

Update const.py

ea3fb07

removing boolean message as only async_set_existing_doorbell_type_duration used it and is no longer needed.

Update doorbot.py

7cd4a0c

Blank lines added to summary/description text per ruff check.

sdb9696 requested changes Aug 30, 2024

View reviewed changes

Comment thread ring_doorbell/doorbot.py Outdated

Switching back to bool and converting to int in the function

1591eb1

briangoldstein changed the title ~~Change async_set_existing_doorbell_type_duration from bool to int~~ Change async_set_existing_doorbell_type_duration to send Ring int instead of bool Aug 30, 2024

briangoldstein requested a review from sdb9696 August 30, 2024 17:31

sdb9696 added the bugfix Label for PRs that fix a bug label Aug 30, 2024

Adding test for async_set_existing_doorbell_type_enabled

548af2d

briangoldstein changed the title ~~Change async_set_existing_doorbell_type_duration to send Ring int instead of bool~~ Change async_set_existing_doorbell_type_enabled to send Ring int instead of bool Sep 2, 2024

Add asserts and extra test steps

4706f9e

sdb9696 approved these changes Sep 2, 2024

View reviewed changes

sdb9696 changed the title ~~Change async_set_existing_doorbell_type_enabled to send Ring int instead of bool~~ Fix method to enable in-home doorbell chime Sep 2, 2024

sdb9696 merged commit 6e98bbc into python-ring-doorbell:master Sep 2, 2024

sdb9696 added this to the 0.9.3 milestone Sep 2, 2024

sdb9696 mentioned this pull request Sep 2, 2024

Prepare 0.9.3 #425

Merged

github-actions Bot locked and limited conversation to collaborators Sep 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix method to enable in-home doorbell chime#419

Fix method to enable in-home doorbell chime#419
sdb9696 merged 8 commits into
python-ring-doorbell:masterfrom
briangoldstein:master

briangoldstein commented Aug 30, 2024

Uh oh!

gitguardian Bot commented Aug 30, 2024 •

edited

Loading

Uh oh!

sdb9696 left a comment

Uh oh!

Uh oh!

coveralls commented Aug 30, 2024

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 30, 2024

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 30, 2024 •

edited

Loading

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 31, 2024

Uh oh!

briangoldstein commented Sep 2, 2024

Uh oh!

sdb9696 commented Sep 2, 2024

Uh oh!

sdb9696 commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

briangoldstein commented Aug 30, 2024

Uh oh!

gitguardian Bot commented Aug 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Uh oh!

sdb9696 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coveralls commented Aug 30, 2024

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 30, 2024

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sdb9696 commented Aug 30, 2024

Uh oh!

briangoldstein commented Aug 31, 2024

Uh oh!

briangoldstein commented Sep 2, 2024

Uh oh!

sdb9696 commented Sep 2, 2024

Uh oh!

sdb9696 commented Sep 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

gitguardian Bot commented Aug 30, 2024 •

edited

Loading

briangoldstein commented Aug 30, 2024 •

edited

Loading