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.

Sign up for GitHub

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

Jump to bottom

Rename OpenThermGatewayDevice to OpenThermGatewayHub #124361

Merged
merged 2 commits into from
Aug 21, 2024
Merged

Rename OpenThermGatewayDevice to OpenThermGatewayHub #124361

merged 2 commits into from
Aug 21, 2024

Conversation

mvn23
Copy link
Contributor

@mvn23 mvn23 commented Aug 21, 2024

Proposed change

The opentherm_gw integration uses a central hub to connect to the OpenTherm Gateway and coordinate the information flows between the various platforms and the actual gateway.
Until now, this hub class had the unfortunate name OpenThermGatewayDevice, with references mostly using device-type names. This is causing confusion with the Home Assistant device structure during development.
This PR changes the class name and its references to OpenThermGatewayHub and hub-type reference names, to make the distinction between the hub and Home Assistant devices clear.

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)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

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
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format 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.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

joostlek
joostlek requested changes Aug 21, 2024
View reviewed changes
Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

Tests are failing

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft August 21, 2024 13:49
@mvn23
Copy link
Contributor Author

mvn23 commented Aug 21, 2024

Tests are failing

Makes sense if I don't include them in the commit 😅

@joostlek
Copy link
Member

FYI, we should avoid mocking internals in the tests, so it would be nice if we can refactor those out at some point

@joostlek joostlek marked this pull request as ready for review August 21, 2024 14:16
@home-assistant home-assistant bot requested a review from joostlek August 21, 2024 14:16
@joostlek joostlek merged commit ec25616 into home-assistant:dev Aug 21, 2024
25 of 26 checks passed
@mvn23 mvn23 deleted the rename-gatewaydevice-to-gatewayhub branch August 21, 2024 15:04
raman325 added a commit to raman325/home-assistant that referenced this pull request Aug 22, 2024
@raman325
Merge branch 'dev' into label
5797c23 
* dev: (642 commits)
  Improve config flow type hints (part 4) (home-assistant#124348)
  Improve config flow type hints (part 1) (home-assistant#124343)
  Add tests for Bring integration (home-assistant#123087)
  Add DROP Alert product support (home-assistant#117867)
  update ttn_client - fix crash with SenseCAP devices (home-assistant#124370)
  Add Aranet Radon Plus support (home-assistant#124197)
  Fix Spotify Media Browsing fails for new config entries (home-assistant#124368)
  Convert Bang & Olufsen testing logging patches to caplog (home-assistant#124366)
  Remove unneeded check for Bang & Olufsen events and device update (home-assistant#124363)
  Bump async-interrupt to 1.2.0 (home-assistant#124360)
  Rename OpenThermGatewayDevice to OpenThermGatewayHub (home-assistant#124361)
  Fix Weatherflow Cloud lightning (home-assistant#124082)
  Change POWER_VOLT_AMPERE_REACTIVE to UnitOfReactivePower (home-assistant#117153)
  Disable Habitica deprecated entities by default (home-assistant#123522)
  Add test cases for ViCare entities (home-assistant#122983)
  Add tests for IronOS integration (home-assistant#123078)
  Fix state name for binary_sensor Power from clear/detected to on/off (home-assistant#116994)
  Extend blebox shutterbox tilt support (home-assistant#110547)
  blebox: use blebox_uniapi.cover.BleboxCoverState enum members instead of plain integers (home-assistant#124302)
  Add custom panel for LCN configuration (home-assistant#108664)
  ...
@github-actions github-actions bot locked and limited conversation to collaborators Aug 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@joostlek joostlek joostlek approved these changes

Assignees
No one assigned
Labels
by-code-owner cla-signed code-quality integration: opentherm_gw Quality Scale: No score
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mvn23 @joostlek