Add flume support

[ChrisMandich]

Description:

Add's sensor for Flume water sensor found here: https://flumetech.com/

Related issue (if applicable): fixes #

Pull request with documentation for home-assistant.io (if applicable): home-assistant/home-assistant.io#10624

Example entry for configuration.yaml (if applicable):

# Example configuration.yaml entry
sensor:
  # Flume
  - platform: flume
    username: YOUR_FLUME_USERNAME
    password: YOUR_FLUME_PASSWORD
    client_id: YOUR_FLUME_CLIENT_ID
    client_secret: YOUR_FLUME_CLIENT_SECRET

Checklist:

• The code change is tested and works locally.
• Local tests pass with tox. Your PR cannot be merged unless tests pass
• There is no commented out code in this PR.
• I have followed the development checklist

If user exposed functionality or configuration variables are added/changed:

• Documentation added/updated in home-assistant.io
  Found here: Added documentation for Flume integration home-assistant.io#10624

If the code communicates with devices, web services, or third-party tools:

• The manifest file has all fields filled out correctly. Update and include derived files by running python3 -m script.hassfest.
• New or updated dependencies have been added to requirements_all.txt by running python3 -m script.gen_requirements_all.
• Untested files have been added to .coveragerc.

If the code does not interact with devices:

• Tests have been added to verify that the new code works.

[ChrisMandich]

@Quentame I'm fairly new to contributing to Github projects. I believe I corrected all they Pylint errors. Can you guide me on what 'codecov/patch' is and what is required to get complete this successfully?

[frenck]

All communication to external devices or services must be wrapped in an external Python library hosted on pypi. See the: https://developers.home-assistant.io/docs/en/development_checklist.html

Furthermore, the config flow requires tests, please add those to make codecov pass.

Lastly, please open up a PR in our documentation repository for this new integration. Please be sure to link the PR in the openings post of this PR.

Thanks! 👍

[Quentame]

Hi again @ChrisMandich !

Me too, I'm quite new in contributions and also in Python dev actually. But most of the comments I've added to your PR are ones I already got while adding config flow to Linky and iCloud components.

I've haven't built a component from the ground up but your PR pushed me to review, hoping someone else will join the game 😉 (I'm not in HA team but new integration with passed pipeline attracts).

I think you should add your untested files to the .coveragerc file (be careful it is checked on the checklist but not made), if it's not that, I don't know 😬

I know that config flow needs tests but this PR doesn't have it (you should consider adding it perhaps).

@frenck : Where are the test/cov requirements written in the documentation ?

In the component checklit there is nothing about the coverage and tests are just strongly recommended.

[balloob]

We should rework how APIs are called. Look at the codebase and search for @Throttle.

[michaeldavie]

Thank for bringing this forward. I've been casually working on a similar project, and I have a couple suggestions:

• My approach uses single data object to support multiple sensors, and uses a single API call with multiple queries to refresh them at the same time. It's similar to what many of the weather components do, and I think it makes sense for Flume as well.
• I've worked out a few queries/sensors to mirror the data provided in the native Flume app.
• I haven't completely worked out the OAuth2 support, and it looks like you might not have either. The tokens issued by Flume expire after a week, so we need to handle either refreshing a token or requesting a new one when the API returns an error indicating that the token is expired.

There's also a thread that a few Flume users are following that might be useful.

Let me know if you have any questions about my code, or if there's anything I can do to help.

[MartinHjelmare]

Looks good!

[Quentame]

So it can be merged ?