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 Aquacell integration #117117

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

Conversation

Jordi1990
Copy link

@Jordi1990 Jordi1990 commented May 8, 2024

Proposed change

This PR adds the Aquacell integration, which can be used to monitor recent models of the Aquacell water softening device. Useful to monitor the salt levels of the device and track salt consumption over time. The API is reverse engineered from the mobile app.

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

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 @Jordi1990,

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! ❤️

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 @Jordi1990,

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! ❤️

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.

Hi @Jordi1990

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

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.

Consider adding tests, which would greatly increase the code quality. I have some examples that are very extendible and work really well :)

homeassistant/components/aquacell/__init__.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 9, 2024 12:48
@home-assistant
Copy link

home-assistant bot commented May 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.

@joostlek
Copy link
Member

Please keep your first PR to only contain 1 platform, so please move the binary sensor to a follow up

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.

Also, if it's ready for review, please use the button for that

homeassistant/components/aquacell/entity.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/entity.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/coordinator.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/strings.json Outdated Show resolved Hide resolved
homeassistant/components/aquacell/strings.json Outdated Show resolved Hide resolved
homeassistant/components/aquacell/config_flow.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/aquacell/sensor.py Outdated Show resolved Hide resolved
@Jordi1990 Jordi1990 marked this pull request as ready for review May 11, 2024 12:43
@home-assistant home-assistant bot requested a review from joostlek May 11, 2024 12:43
@joostlek joostlek marked this pull request as draft May 11, 2024 13:06
@Jordi1990 Jordi1990 marked this pull request as ready for review May 14, 2024 21:13
@home-assistant home-assistant bot requested a review from joostlek May 14, 2024 21:13
Change sensor entity descriptions
Use icon translations
Removed reauth
Removed last updated sensor
Changed lid in place to binary sensor
Cleanup
Fixed sensors not updating properly
Bump aioaquacell
Inlined validate_input method
Renaming of entities
Do a single async_add_entities call to add all entities
Reduced code in try blocks
Cleaned up unused code
Removed traces of reauth
@Jordi1990
Copy link
Author

@joostlek Ready to review, wasn't sure if you've noticed.

@joostlek
Copy link
Member

Oh i did not

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.

None yet

2 participants