iRobot more diagnostic sensors

[Xitee1]

Breaking change

Proposed change

The iRobot integration currently unlike the official iRobot-App does not show much information's/statistics about the robot like the total missions and total cleaning time. I've found out that the information's are already available and there just are no sensors for it. So I have added the following sensors:

• missions cancelled: Total missions that have been cancelled
• missions failed: Total missions that have failed
• missions successful: Total successful missions
• missions total: All total missions together
• scrubs count: Total amount of how often the robot has executed "scrub"
• total cleaning time: How long the robot has spend cleaning (total) (in hours)

The following attributes to the vacuum entity have been added too:

• Battery cycles
• Average mission time (in minutes)
  

I hope that I did everything correctly. This is my first PR :)

Type of change

• [ ] Dependency upgrade
• [ ] Bugfix (non-breaking change which fixes an issue)
• [ ] New integration (thank you!)
• [X] 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: https://github.com/home-assistant/home-assistant.io/pull/25509

Checklist

• [X] The code change is tested and works locally.
• [X] Local tests pass. Your PR cannot be merged unless tests pass
• [X] There is no commented out code in this PR.
• [X] I have followed the development checklist
• [X] 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:

• [X] Documentation added/updated for www.home-assistant.io

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:

• [ ] I have reviewed two other open pull requests in this repository.

[home-assistant[bot]]

Hi Xitee1

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!

[home-assistant[bot]]

Hey there @pschmitt, @cyr-ius, @shenxn, mind taking a look at this pull request as it has been labeled with an integration (roomba) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of roomba can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Change the title of the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign roomba Removes the current integration label and assignees on the issue, add the integration domain after the command.

[930913]

Btw, you still need to sign the CLA as mentioned in the comment above.

[Xitee1]

Btw, you still need to sign the CLA as mentioned in the comment above.

I already have signed CLA. The bot has even added the "cla-signed" label to the PR.

[930913]

So you have! I must have missed that :facepalm:

[Xitee1]

Is there anything wrong with this? This PR is open for months now and still hasn't been merged.

[home-assistant[bot]]

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

Learn more about our pull request process.

[Xitee1]

Please resolve conflicts

I checked it in my IDE and manually edited it in the Github web editor because for some reason almost all checks fail after merging dev into irobot_more_sensors. I have resolved the conflicts and comitted but for some reason Github still says there are conflicts. And I can't resolve it in the Github conflicts web editor because apparently it is too much for the merge web editor even thought it is a single line of code.

I'm giving up at this now.. such an easy and simple addition and so much stress and time consuming getting that PR trough. If anyone wants to still use it, I found out that you can just copy and paste the "roomba" folder (the integration) in the custom_components folder in HA if you have HACS installed. Then restart HA and you have the new sensors.

[bdraco]

I'm going to close this PR since you've indicated you don't want to continue this. Feel free to reopen or make a new one if you change your mind later.

Thanks for willing to contribute 👍

[Xitee1]

I just tried it once more on Ubuntu with PyCharm instead Windows with Visual Studio Code and seems to have worked.. in only 5 minutes. Now Github says able to merge. Could we re-open this? I really want to get this merged.

[home-assistant[bot]]

Hello @Xitee1,

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:

• ea4121f7f1e54572b3f87d2eece93326c6eb77e5 - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

• 78fb9955151a3d08fc2c20e9b0d086cad88bb63a - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

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 protected]>"
     

     (substituting "Author Name" and "[email protected]" 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! :heart:

[home-assistant[bot]]

Hello @Xitee1,

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:

• ea4121f7f1e54572b3f87d2eece93326c6eb77e5 - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

• 78fb9955151a3d08fc2c20e9b0d086cad88bb63a - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

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 protected]>"
     

     (substituting "Author Name" and "[email protected]" 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! :heart:

[home-assistant[bot]]

Hello @Xitee1,

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:

• ea4121f7f1e54572b3f87d2eece93326c6eb77e5 - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

• 78fb9955151a3d08fc2c20e9b0d086cad88bb63a - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

• 4792650a52d4d67b947223e63141b698860f2a3d - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

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 protected]>"
     

     (substituting "Author Name" and "[email protected]" 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! :heart:

[bdraco]

@bdraco you made some changes so you're happy with this to merge it?

I was just helping out to fix the permissions issue. I have not tested or fully reviewed

[Xitee1]

@bdraco I've made the changes you've suggested. Let me know if it is okay. I will test it once from the code side everything is ok.

[frenck]

@Xitee1 Considering the age of this PR:

• Please rebase it onto the latest upstream dev branch
• Resolve the merge conflict
• Mark it ready for review (undraft it), once it is ready for another review pass.

Thanks!

../Frenck

[Xitee1]

@frenck Done.

[joostlek]

Also tested and looks okay