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

Add integration for APsystems EZ1 microinverter #114531

Merged
merged 19 commits into from
May 15, 2024

Conversation

mawoka-myblock
Copy link
Contributor

@mawoka-myblock mawoka-myblock commented Mar 31, 2024

Proposed change

The APsystems EZ1 microinverter has an open local HTTP api and I've created the integration over at https://github.com/SonnenladenGmbH/APsystems-EZ1-API-HomeAssistant but the people wanted to be integrated into HomeAssistant directly.

The following library is used: https://github.com/SonnenladenGmbH/APsystems-EZ1-API

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 is my first PR, so I tried my best.

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Copy link
Member

@Kane610 Kane610 left a comment

Choose a reason for hiding this comment

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

Couple of comments don't forget to add a link to the library

@mawoka-myblock
Copy link
Contributor Author

I've just checked the test coverage: 96% as the lines returning the successfully created config never get tested, as AiohttpClientMockResponse doesn't implement .ok() which is used by the apsystemsapi-library, so the tests just check if the code comes as far to check if the response was okay.

@mawoka-myblock
Copy link
Contributor Author

mawoka-myblock commented Apr 9, 2024

I've now increased the coverage to 100% for the config flow and from my side, everything is ready. I'd appreciate a new review @joostlek or @Kane610.

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.

I won't have any room to do more reviews the coming weeks

tests/components/apsystemsapi_local/test_config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/apsystemsapi_local/sensor.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

home-assistant bot commented Apr 9, 2024

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 April 9, 2024 13:38
@mawoka-myblock mawoka-myblock marked this pull request as ready for review April 10, 2024 05:21
@home-assistant home-assistant bot requested a review from joostlek April 10, 2024 05:21
@mawoka-myblock
Copy link
Contributor Author

Maybe @CM000n, could you leave a review?

@mawoka-myblock
Copy link
Contributor Author

mawoka-myblock commented Apr 27, 2024

@joostlek Pinging you in the hopes that you've got capacity for hopefully the last review for this PR.

@joostlek
Copy link
Member

No, I'm still busy with my thesis

@balloob
Copy link
Member

balloob commented May 14, 2024

Did you run python3 -m script.translations develop ?

@mawoka-myblock
Copy link
Contributor Author

Nope, that seemed to be the problem.

.coveragerc Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 14, 2024 20:07
@mawoka-myblock mawoka-myblock marked this pull request as ready for review May 14, 2024 20:24
@home-assistant home-assistant bot requested a review from balloob May 14, 2024 20:24
@balloob balloob merged commit d4d30f1 into home-assistant:dev May 15, 2024
34 checks passed
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.

Please fix these comments in a follow up PR

@@ -81,6 +81,10 @@ omit =
homeassistant/components/aprilaire/climate.py
homeassistant/components/aprilaire/coordinator.py
homeassistant/components/aprilaire/entity.py
homeassistant/components/apsystems/__init__.py
homeassistant/components/apsystems/const.py
Copy link
Member

Choose a reason for hiding this comment

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

const doesn't have any coverage checks


async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
"""Set up this integration using UI."""
entry.runtime_data = {}
Copy link
Member

Choose a reason for hiding this comment

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

Can be removed

api = APsystemsEZ1M(ip_address=entry.data[CONF_IP_ADDRESS], timeout=8)
coordinator = ApSystemsDataCoordinator(hass, api)
await coordinator.async_config_entry_first_refresh()
entry.runtime_data = {"COORDINATOR": coordinator}
Copy link
Member

Choose a reason for hiding this comment

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

We should type the ConfigEntry using the generic type

Comment on lines +1 to +21
{
"config": {
"step": {
"user": {
"data": {
"host": "[%key:common::config_flow::data::host%]",
"username": "[%key:common::config_flow::data::username%]",
"password": "[%key:common::config_flow::data::password%]"
}
}
},
"error": {
"cannot_connect": "[%key:common::config_flow::error::cannot_connect%]",
"invalid_auth": "[%key:common::config_flow::error::invalid_auth%]",
"unknown": "[%key:common::config_flow::error::unknown%]"
},
"abort": {
"already_configured": "[%key:common::config_flow::abort::already_configured_device%]"
}
}
}
Copy link
Member

Choose a reason for hiding this comment

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

The strings are not updated. I am missing the config flow string and I am missing all of the entity translations

homeassistant/components/apsystems/sensor.py Show resolved Hide resolved
@github-actions github-actions bot locked and limited conversation to collaborators May 16, 2024
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.

None yet

6 participants