Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for real-time data from SimpliSafe #31424

Merged
merged 19 commits into from Feb 13, 2020
Merged

Conversation

@bachya
Copy link
Contributor

bachya commented Feb 3, 2020

Proposed change

This PR allows HASS to respond to real-time events from the SimpliSafe cloud websocket. In this first iteration, the integration will respond to these events:

  • alarm_canceled
  • alarm_triggered
  • armed_away
  • armed_away_by_keypad
  • armed_away_by_remote
  • armed_home
  • away_exit_delay_by_keypad
  • away_exit_delay_by_remote
  • disarmed_by_master_pin
  • disarmed_by_remote
  • home_exit_delay
  • lock_error
  • lock_locked
  • lock_unlocked

...and will update the state of alarm_control_panel and lock entities.

This PR doesn't completely remove the reliance on the REST API, since that remains the only source for many of the alarm_control_panel attributes. Therefore, the integration will continue to poll the REST API every 30 seconds (which means I won't update the docs to say this is a push-based integration).

Marking this as a draft PR while I ask the community to help me test (I'm particularly interested in how this works for v2 systems).

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example entry for configuration.yaml:

# Example configuration.yaml
simplisafe:
  accounts:
    username: !secret simplisafe_username
    password: !secret simplisafe_password

Additional information

  • This PR fixes or closes issue: #31029
  • This PR is related to issue: N/A
  • Link to documentation pull request: N/A

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum
@bachya bachya self-assigned this Feb 3, 2020
@project-bot project-bot bot added this to Needs review in Dev Feb 3, 2020
@project-bot project-bot bot moved this from Needs review to By Code Owner in Dev Feb 3, 2020
@bachya bachya force-pushed the bachya:ss-websocket branch from ad986ce to 90e7b6e Feb 3, 2020
bachya added 9 commits Feb 3, 2020
@bachya bachya force-pushed the bachya:ss-websocket branch from d64fb86 to b885bd9 Feb 4, 2020
bachya added 4 commits Feb 5, 2020
This reverts commit e7ffe05.
@asierralozano

This comment was marked as off-topic.

Copy link

asierralozano commented Feb 7, 2020

Hello!
Does this new API implements the comunication with Simplisafe's motion sensors?
Thanks!

@bachya

This comment was marked as off-topic.

Copy link
Contributor Author

bachya commented Feb 7, 2020

@asierralozano Not at this time, unfortunately. Sensor events don鈥檛 propagate down the websocket in a way that makes them useful (and polling these sensors isn鈥檛 a great experience with SimpliSafe鈥檚 current architecture).

@bachya bachya marked this pull request as ready for review Feb 12, 2020
@bachya

This comment has been minimized.

Copy link
Contributor Author

bachya commented Feb 12, 2020

I've been running this in production for over a week straight and everything appears good; no feedback to the contrary from anyone. Going to open this up for (further) review.

bachya added 3 commits Feb 12, 2020
Dev automation moved this from By Code Owner to Reviewer approved Feb 13, 2020
@balloob balloob merged commit f091e04 into home-assistant:dev Feb 13, 2020
10 checks passed
10 checks passed
CI Build #20200213.33 succeeded
Details
CI (FullCheck Mypy) FullCheck Mypy succeeded
Details
CI (FullCheck Pylint) FullCheck Pylint succeeded
Details
CI (Overview CheckFormat) Overview CheckFormat succeeded
Details
CI (Overview Lint) Overview Lint succeeded
Details
CI (Overview Validate) Overview Validate succeeded
Details
CI (Tests PyTest Python37) Tests PyTest Python37 succeeded
Details
cla-bot Everyone involved has signed the CLA
codecov/patch 100% of diff hit (target 94.62%)
Details
codecov/project 94.68% (target 90%)
Details
Dev automation moved this from Reviewer approved to Done Feb 13, 2020
@bachya bachya deleted the bachya:ss-websocket branch Feb 13, 2020
@bachya bachya mentioned this pull request Feb 13, 2020
9 of 20 tasks complete
@lock lock bot locked and limited conversation to collaborators Feb 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can鈥檛 perform that action at this time.