Move totalconnect from platform to component config by austinmroczek · Pull Request #24427 · home-assistant/core

austinmroczek · 2019-06-08T23:38:35Z

Breaking Change:

Total Connect Client was upgraded to support more than one alarm panel and allow future support for additional sensors. Previous alarm_control_panel entries must be removed, and a new totalconnect entry must be added to configuration.yaml. See https://www.home-assistant.io/components/totalconnect/ for configuration details.

Description:

Move toward multi-platform for Total Connect. Support multiple alarm panels. Changed totalconnect so we can add additional platforms moving forward. Moved the total_connect_client into init so a single instance will be shared across platforms. It should now allow for multiple alarm panels.

Related issue (if applicable):
craigjmidwinter/total-connect-client#26

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#
home-assistant/home-assistant.io#9589

Example entry for `configuration.yaml` (if applicable):

totalconnect:
    username: !secret totalconnect_username
    password: !secret totalconnect_password

Checklist:

The code change is tested and works locally.
Local tests pass with tox. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the [development checklist][dev-checklist]

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

[doing next] Documentation added/updated in home-assistant.io

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

[The manifest file][manifest-docs] has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
[n/a] Untested files have been added to .coveragerc.

If the code does not interact with devices:

[n/a] Tests have been added to verify that the new code works.

update to latest HA

…into dev

it is a burglar or fire or carbon monoxide so automations can take appropriate actions. Updated TotalConnect component to handle these new states.

….git into dev

update

Also bumps total_connect_client to 0.27.

https://github.com/austinmroczek/home-assistant.git into dev

…into dev

…. Bump total_connect_client to 0.28.

pull in latest

MartinHjelmare · 2019-06-30T08:28:19Z

Please extend the breaking change paragraph and explain in more detail what the user needs to do to cope with the breaking change. We don't need to explain the config options. It's ok to reference the docs for those.

MartinHjelmare · 2019-06-30T08:31:26Z

.coveragerc needs to be updated. We can use a star * to mark the whole totalconnect package as excluded from coverage calculation.

home-assistant#24427

austinmroczek · 2019-06-30T21:24:12Z

@MartinHjelmare thanks for the detailed code review. I made updates per your guidance, changed .coveragerc and expanded the breaking change notes.

MartinHjelmare · 2019-07-11T11:49:46Z

There's only some small fixes left needed here.

austinmroczek · 2019-07-12T05:27:55Z

Sorry I’ve been away. Should finish up this weekend

….git into dev

MartinHjelmare

Great!

…4427) * Move totalconnect component toward being a multi-platform integration. Bump total_connect_client to 0.28. * add missing total-connect alarm state mappings * Made recommended changes of MartinHjelmare at home-assistant#24427 * Update __init__.py * Updates per MartinHjelmare comments * flake8/pydocstyle fixes * removed . at end of log message * added blank line between logging and voluptuous * more fixes

@springstan

* Bump skybellpy to 0.4.0 * Bump skybellpy to 0.4.0 in requirements_all.txt * Added extra states for STATE_ALARM_TRIGGERED to allow users to know if it is a burglar or fire or carbon monoxide so automations can take appropriate actions. Updated TotalConnect component to handle these new states. * Fix const import * Fix const import * Fix const imports * Bump total-connect-client to 0.26. * Catch details of alarm trigger in state attributes. Also bumps total_connect_client to 0.27. * Change state_attributes() to device_state_attributes() * Move totalconnect component toward being a multi-platform integration. Bump total_connect_client to 0.28. * add missing total-connect alarm state mappings * Made recommended changes of MartinHjelmare at #24427 * Update __init__.py * Updates per MartinHjelmare comments * flake8/pydocstyle fixes * removed . at end of log message * added blank line between logging and voluptuous * more fixes * Adding totalconnect zones as HA binary_sensors * fix manifest.json * flake8/pydocstyle fixes. Added codeowner. * Update formatting per @springstan guidance. * Fixed pylint * Add zone ID to log message for easier troubleshooting * Account for bypassed zones in update() * More status handling fixes. * Fixed flake8 error * Another attempt at black/isort fixes. * Bump total-connect-client to 0.50. Simplify code using new functions in total-connect-client package instead of importing constants. Run black and isort. * Fix manifest file * Another manifest fix * one more manifest fix * more manifest changes. * sync up * fix indent * one more pylint fix * Hopefully the last pylint fix * make variable names understandable * create and fill dict in one step * Fix name and attributes * rename to logical variable in alarm_control_panel * Remove location_name from alarm_control_panel attributes since it is already the name of the alarm. * Multiple fixes to improve code per @springstan suggestions * Update homeassistant/components/totalconnect/binary_sensor.py Co-Authored-By: springstan <46536646+springstan@users.noreply.github.com> * Multiple changes per @MartinHjelmare review * simplify alarm adding * Fix binary_sensor.py is_on Co-authored-by: springstan <46536646+springstan@users.noreply.github.com>

@springstan

* Bump skybellpy to 0.4.0 * Bump skybellpy to 0.4.0 in requirements_all.txt * Added extra states for STATE_ALARM_TRIGGERED to allow users to know if it is a burglar or fire or carbon monoxide so automations can take appropriate actions. Updated TotalConnect component to handle these new states. * Fix const import * Fix const import * Fix const imports * Bump total-connect-client to 0.26. * Catch details of alarm trigger in state attributes. Also bumps total_connect_client to 0.27. * Change state_attributes() to device_state_attributes() * Move totalconnect component toward being a multi-platform integration. Bump total_connect_client to 0.28. * add missing total-connect alarm state mappings * Made recommended changes of MartinHjelmare at #24427 * Update __init__.py * Updates per MartinHjelmare comments * flake8/pydocstyle fixes * removed . at end of log message * added blank line between logging and voluptuous * more fixes * Adding totalconnect zones as HA binary_sensors * fix manifest.json * flake8/pydocstyle fixes. Added codeowner. * Update formatting per @springstan guidance. * Fixed pylint * Add zone ID to log message for easier troubleshooting * Account for bypassed zones in update() * More status handling fixes. * Fixed flake8 error * Another attempt at black/isort fixes. * Bump total-connect-client to 0.50. Simplify code using new functions in total-connect-client package instead of importing constants. Run black and isort. * Fix manifest file * Another manifest fix * one more manifest fix * more manifest changes. * sync up * fix indent * one more pylint fix * Hopefully the last pylint fix * make variable names understandable * create and fill dict in one step * Fix name and attributes * rename to logical variable in alarm_control_panel * Remove location_name from alarm_control_panel attributes since it is already the name of the alarm. * Multiple fixes to improve code per @springstan suggestions * Update homeassistant/components/totalconnect/binary_sensor.py Co-Authored-By: springstan <46536646+springstan@users.noreply.github.com> * Multiple changes per @MartinHjelmare review * simplify alarm adding * Fix binary_sensor.py is_on * Move DOMAIN to .const in line with examples. * Move to async_setup * Simplify code using new features of total-connect-client 0.51 * First crack at config flow for totalconnect * bump totalconnect to 0.52 * use client.is_logged_in() to avoid total-connect-client details. * updated generated/config_flow.py * use is_logged_in() * Hopefully final touches for config flow * Add tests for config flow * Updated requirements for test * Fixes to test_config_flow * Removed leftover comments and code * fix const.py flake8 error * Simplify text per @Kane610 #32126 (review) * Remove .get() to speed things up since the required items should always be available. * Move CONF_USERNAME and CONF_PASSWORD into .const to eliminate extra I/O to import from homeassistant.const * Fix I/O async issues * Fix flake8 and black errors * Mock the I/O in tests. * Fix isort error * Empty commit to re-start azure pipelines (per discord) * bump total-connect-client to 0.53 * Update homeassistant/components/totalconnect/__init__.py Co-Authored-By: Paulus Schoutsen <paulus@home-assistant.io> * Update homeassistant/components/totalconnect/config_flow.py Co-Authored-By: Paulus Schoutsen <paulus@home-assistant.io> * Fixes per @balloob comments * Fix imports * fix isort error * Fix async_unload_entry It still referenced CONF_USERNAME instead of entry.entity_id * Added async_setup so not breaking change. Fixed imports. * Update tests/components/totalconnect/test_config_flow.py Co-Authored-By: Martin Hjelmare <marhje52@gmail.com> * Remove TotalConnectSystem() per @MartinHjelmare suggestion * Moved from is_logged_in() to is_valid_credentials() The second is more accurate for what we are checking for, because is_logged_in() could return False due to connection error. * Fix import in test * remove commented code and decorator * Update tests/components/totalconnect/test_config_flow.py Co-Authored-By: Martin Hjelmare <marhje52@gmail.com> * fix test_config_flow.py * bump total-connect-client to 0.54 * remove un-needed import of mock_coro * bump to total-connect-client 0.54.1 * re-add CONFIG_SCHEMA * disable pylint on line 10 to avoid pylint bug Co-authored-by: springstan <46536646+springstan@users.noreply.github.com> Co-authored-by: Paulus Schoutsen <paulus@home-assistant.io> Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

austinmroczek added 17 commits April 13, 2019 17:34

Merge pull request #1 from home-assistant/dev

54dbdd6

update to latest HA

Merge branch 'dev' of https://github.com/home-assistant/home-assistant …

90483d2

…into dev

Bump skybellpy to 0.4.0

51aa773

Bump skybellpy to 0.4.0 in requirements_all.txt

e18b4d2

Added extra states for STATE_ALARM_TRIGGERED to allow users to know if

d74156a

it is a burglar or fire or carbon monoxide so automations can take appropriate actions. Updated TotalConnect component to handle these new states.

Merge branch 'dev' of https://github.com/austinmroczek/home-assistant…

ad1cdb3

….git into dev

Merge pull request #2 from home-assistant/dev

5c5c052

update

Fix const import

abcc85a

Fix const import

d303091

Fix const imports

73f38eb

Bump total-connect-client to 0.26.

5bec7e4

Catch details of alarm trigger in state attributes.

4862ff5

Also bumps total_connect_client to 0.27.

Merge branch 'dev' of

5068345

https://github.com/austinmroczek/home-assistant.git into dev

Change state_attributes() to device_state_attributes()

e7a13d4

Merge remote-tracking branch 'upstream/dev' into dev

53f20fb

Merge branch 'dev' of https://github.com/austinmroczek/home-assistant …

4bee662

…into dev

Move totalconnect component toward being a multi-platform integration…

6a50e80

…. Bump total_connect_client to 0.28.

homeassistant added integration: totalconnect cla-signed labels Jun 8, 2019

austinmroczek mentioned this pull request Jun 8, 2019

Update totalconnect.markdown home-assistant/home-assistant.io#9589

Merged

1 task

austinmroczek added 2 commits June 29, 2019 16:02

Merge pull request #4 from home-assistant/dev

37c34cf

pull in latest

add missing total-connect alarm state mappings

ad4c4c9

MartinHjelmare changed the title ~~Move toward multi-platform for Total Connect. Support multiple alarm panels.~~ Move totalconnect from platform to component config Jun 30, 2019

MartinHjelmare requested changes Jun 30, 2019

View reviewed changes

MartinHjelmare added the breaking-change label Jun 30, 2019

Made recommended changes of MartinHjelmare at

e589317

home-assistant#24427

MartinHjelmare reviewed Jul 1, 2019

View reviewed changes

Comment thread homeassistant/components/totalconnect/__init__.py Outdated

MartinHjelmare reviewed Jul 1, 2019

View reviewed changes

Comment thread homeassistant/components/totalconnect/__init__.py

Comment thread homeassistant/components/totalconnect/__init__.py

Comment thread homeassistant/components/totalconnect/alarm_control_panel.py Outdated

Update __init__.py

aa22440

austinmroczek added 3 commits July 13, 2019 11:04

Updates per MartinHjelmare comments

5cbfc98

flake8/pydocstyle fixes

eb440cc

Merge branch 'dev' of https://github.com/austinmroczek/home-assistant…

69425d7

….git into dev

MartinHjelmare reviewed Jul 13, 2019

View reviewed changes

Comment thread homeassistant/components/totalconnect/__init__.py Outdated

austinmroczek added 2 commits July 13, 2019 12:48

removed . at end of log message

117ed1b

added blank line between logging and voluptuous

14d3e2e

MartinHjelmare reviewed Jul 14, 2019

View reviewed changes

Comment thread homeassistant/components/totalconnect/alarm_control_panel.py Outdated

MartinHjelmare reviewed Jul 14, 2019

View reviewed changes

Comment thread homeassistant/components/totalconnect/__init__.py Outdated

more fixes

cd2b563

MartinHjelmare approved these changes Jul 14, 2019

View reviewed changes

MartinHjelmare merged commit 369e6a3 into home-assistant:dev Jul 14, 2019

balloob mentioned this pull request Aug 7, 2019

0.97.0 #25756

Merged

Uh oh!

Conversation

austinmroczek commented Jun 8, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking Change:

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Jun 30, 2019

Uh oh!

MartinHjelmare commented Jun 30, 2019

Uh oh!

austinmroczek commented Jun 30, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Jul 11, 2019

Uh oh!

austinmroczek commented Jul 12, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

austinmroczek commented Jun 8, 2019 •

edited

Loading

Example entry for `configuration.yaml` (if applicable):