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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change Insteon backend module to pyinsteon from insteonplm #35198

Merged
merged 22 commits into from
May 17, 2020

Conversation

teharris1
Copy link
Contributor

@teharris1 teharris1 commented May 4, 2020

Breaking change

This PR will change the entity ID of some entities. Specifically the following entity types will be impacted:

  • X10 dimmers, switches and sensors
  • SmokeBridge sensor

Additionally, X10 entities for:

  • x10_all_units_off
  • x10_all_lights_on
  • x10_all_lights_off

No longer appear as entities as they are not needed.

Proposed change

Change the backend module from insteonplm to pyinsteon. This change enables significant improvements to the Insteon component that include:

  1. Consistent state status for changes to state outside of Home Assistant (i.e. three-way switches)
  2. Improved insteon scene triggering.
  3. Full coexistance with the Insteon Hub app.

All changes in the PR are specifically to enable the use of pyinsteon. The benefits above are a direct result of the use of the new module.

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
insteon:
  port: /dev/ttyUSB0

Additional information

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:

  • [ ]xThe 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

@MartinHjelmare MartinHjelmare changed the title Insteon change backend module to pyinsteon from insteonplm Change Insteon backend module to pyinsteon from insteonplm May 9, 2020
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please be wary about the context of the functions and what api we're using, async or sync. Those need to match.

homeassistant/components/insteon/insteon_entity.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/insteon_entity.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/insteon_entity.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/utils.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/utils.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/__init__.py Show resolved Hide resolved
homeassistant/components/insteon/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/cover.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/fan.py Outdated Show resolved Hide resolved
homeassistant/components/insteon/fan.py Outdated Show resolved Hide resolved
@teharris1
Copy link
Contributor Author

@MartinHjelmare Thanks for reviewing this PR. I know it was a pain in the ars given the number of changes required.

@teharris1
Copy link
Contributor Author

@MartinHjelmare Any chance this makes it into 0.110.x?

@MartinHjelmare
Copy link
Member

We're passed the beta cut for 0.110.0, so no.

.env Outdated Show resolved Hide resolved
Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great!

@teharris1
Copy link
Contributor Author

I assume there is a bigger issue with tests right now since removing that .env file should not have broken anything.

@MartinHjelmare MartinHjelmare merged commit dbd821a into home-assistant:dev May 17, 2020
@teharris1 teharris1 deleted the insteon branch May 19, 2020 13:00
@lock lock bot locked and limited conversation to collaborators May 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants