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

Reorganize insteon code #31183

Merged
merged 2 commits into from Jan 30, 2020
Merged

Reorganize insteon code #31183

merged 2 commits into from Jan 30, 2020

Conversation

teharris1
Copy link
Contributor

@teharris1 teharris1 commented Jan 26, 2020

Breaking change

The Insteon entity device state attributes were changed to conform to naming standards. Insteon Address is now insteon_address and Insteon Group is now insteon_group. Users may need to update automations and scripts that rely on these attributes.

Proposed change

Reorganize the insteon component code to make future edits easier.

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

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

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

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 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/insteon_entity.py Outdated Show resolved Hide resolved
Dev automation moved this from Needs review to Review in progress Jan 26, 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.

Good!

Can be merged when the breaking change paragraph is updated. Please ping me when that is done.

Dev automation moved this from Review in progress to Reviewer approved Jan 28, 2020
@teharris1
Copy link
Contributor Author

@MartinHjelmare I have added the paragraph to the breaking change section but I am not sure there is anything a user needs to do to cope with that change since I don't believe the attributes are used for anything other than documentation.

@MartinHjelmare
Copy link
Member

Ok. I added a sentence about automations and scripts where it at least theoretically could be used.

@MartinHjelmare
Copy link
Member

Let's wait with merging this until the beta for 0.105 is cut later today. Then there's more time for further PRs with breaking changes for this integration this release cycle.

@pvizeli pvizeli merged commit 7ff30fe into home-assistant:dev Jan 30, 2020
Dev automation moved this from Reviewer approved to Done Jan 30, 2020
@lock lock bot locked and limited conversation to collaborators Jan 31, 2020
@teharris1 teharris1 deleted the reorg branch February 8, 2020 22:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants