8000 Add actronairneo climate integration by kclif9 · Pull Request #134740 · home-assistant/core · GitHub
[go: up one dir, main page]

Skip to content

Add actronairneo climate integration #134740

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

Open
wants to merge 114 commits into
base: dev
Choose a base branch
from

Conversation

kclif9
Copy link
@kclif9 kclif9 commented Jan 5, 2025 8000

Proposed change

Contribute a new integration to Home Assistant - Actron Air Neo. This PR pertains to the Climate platform.

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

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:

Copy link
@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hello @kclif9,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

  1. If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.

  2. If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.

    • If you only made a single commit you should be able to run
      git commit --amend --author="Author Name <email@address.com>"
      
      (substituting "Author Name" and "email@address.com" for your actual information) to set the authorship information.
    • If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
      1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
      2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
    • Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

@home-assistant
Copy link
home-assistant bot commented Jan 5, 2025

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.

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.

You marked rules complete in the quality scale.yaml which in fact are not complete. Please re review the rules and make sure the full quality scale is in there

@home-assistant home-assistant bot marked this pull request as draft January 5, 2025 09:08
@kclif9
Copy link
Author
kclif9 commented Jan 5, 2025

You marked rules complete in the quality scale.yaml which in fact are not complete. Please re review the rules and make sure the full quality scale is in there

I believe I've implemented all the bronze standard rules. Can you please advise which need to be fixed?

@kclif9 kclif9 requested a review from joostlek January 6, 2025 10:56
@kclif9 kclif9 marked this pull request as ready for review January 9, 2025 11:14
@home-assistant home-assistant bot marked this pull request as draft January 10, 2025 12:42
@kclif9 kclif9 marked this pull request as ready for review May 17, 2025 22:29
@home-assistant home-assistant bot requested a review from joostlek May 17, 2025 22:29
@home-assistant home-assistant bot marked this pull request as draft May 18, 2025 17:06
@kclif9 kclif9 marked this pull request as ready for review May 19, 2025 12:03
@home-assistant home-assistant bot requested a review from joostlek May 19, 2025 12:03
Comment on lines 39 to 63
class ActronNeoApiCoordinator:
"""Coordinator for Actron Neo API."""

def __init__(self, hass: HomeAssistant, entry: ActronNeoConfigEntry) -> None:
"""Initialize the coordinator."""
self.hass = hass
self.entry = entry
self.api = ActronNeoAPI(pairing_token=entry.data[CONF_API_TOKEN])
self.systems: list[ActronAirNeoACSystem] = []

async def async_setup(self) -> bool:
"""Perform initial setup, including refreshing the token."""
try:
await self.api.refresh_token()
systems = await self.api.get_ac_systems()
self.systems = systems
except ActronNeoAuthError:
_LOGGER.error(
"Authentication error while setting up Actron Neo integration"
)
raise
except ActronNeoAPIError as err:
_LOGGER.error("API error while setting up Actron Neo integration: %s", err)
raise
return True
Copy link
Member

Choose a reason for hiding this comment

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

Why do we have this separate class? Can we merge it with the coordinator?

Copy link
Author

Choose a reason for hiding this comment

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

I separated it into its own class as the same API endpoint can return multiple systems. It made sense to me to break it into two separate classes such that the initial step in initalisation connects to the API and retrieves systems, then the second step creates the classes for the system coordinators.

This way there cannot be any confusion between having multiple API endpoints (such as if you have two Actron Neo accounts) and multiple systems

Copy link
Member

Choose a reason for hiding this comment

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

How do you mean the second step? currently I kinda see this as a wrapper for the client, and a part of a data holder, which is a role that the coordinator already has

Copy link
Author

Choose a reason for hiding this comment

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

In the init file, I connect to the API to pull in the systems that are connected to the account, then have a separate coordinator instance for each system. This significantly reduces the complexity of the integration.

My concern behind merging them back together, and together with your previous recommendations around simplifying the coordinator, it may get complicated if I'm instantiating a coordinator, then creating additional instances for multiple systems. Separating the logic for the two makes sense to me as they do serve separate purposes, and makes it easier when you have multiple systems under a single account.

To make the naming clearer, I've renamed the ApiCoordinator to ApiClient as that reflects more accurately what its purpose is. Are you okay with this approach?

@home-assistant home-assistant bot marked this pull request as draft May 22, 2025 09:28
@kclif9 kclif9 marked this pull request as ready for review May 23, 2025 07:48
@home-assistant home-assistant bot requested a review from joostlek May 23, 2025 07:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0