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

Somfy open api #9625

Merged
merged 9 commits into from
Jun 18, 2019
Merged

Somfy open api #9625

merged 9 commits into from
Jun 18, 2019

Conversation

tetienne
Copy link
Contributor

Description:

Pull request in home-assistant: home-assistant/core#19548

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next home-assistant release. Fixes, changes and adjustments for the current release should be created against current.
  • The documentation follows the standards.

@tetienne tetienne mentioned this pull request Jun 12, 2019
8 tasks
@klaasnicolaas
Copy link
Member

Please merge the cover.somfy.markdown inside the somfy.markdown

@klaasnicolaas klaasnicolaas added has-parent This PR has a parent PR in a other repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch ready-for-review This PR needs to be reviewed labels Jun 13, 2019
@frenck frenck added parent-merged The parent PR has been merged already in-progress This PR/Issue is currently being worked on and removed ready-for-review This PR needs to be reviewed labels Jun 18, 2019
@frenck frenck assigned frenck and tetienne and unassigned frenck Jun 18, 2019
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Hi @tetienne, could you please resolve the request by @klaasnicolaas? That allows us to merge this PR in and finish up the docs for 0.95

@tetienne
Copy link
Contributor Author

Sorry I didn't see your message @klaasnicolaas @frenck. Cover documentation has been merged.

@frenck frenck assigned frenck and unassigned tetienne Jun 18, 2019
@frenck
Copy link
Member

frenck commented Jun 18, 2019

Thanks, @tetienne for that extreme quick response there! 🐎

I'll take a look in a second.

@tetienne tetienne force-pushed the somfy-open-api branch 2 times, most recently from 3bcaad6 to 0af0849 Compare June 18, 2019 19:13
@tetienne
Copy link
Contributor Author

You are welcome 😊

- Hub
ha_iot_class: Cloud Polling
ha_release: 0.95
ha_qa_scale: gold
Copy link
Member

@frenck frenck Jun 18, 2019

Choose a reason for hiding this comment

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

The quality scale index is incorrect IMHO. For a gold standard, there should be tests between HA & the integration. Currently, I only see tests for the configuration flow. (which are excluded from the code coverage, which it should NOT have been btw...)

See: https://developers.home-assistant.io/docs/en/integration_quality_scale_index.html

For now, I suggest removing this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Are you talking about this:

Tests for reading data from/controlling the integration (docs)

What do you think to replace by Silver 🥈 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the coverage, I will see how include my tests.

Copy link
Member

@frenck frenck Jun 18, 2019

Choose a reason for hiding this comment

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

Well for silver it should:

✅ Connection/configuration is handled via a component.
❌ Set an appropriate SCAN_INTERVAL (if a polling integration)
❌ Raise PlatformNotReady if unable to connect during platform setup (if appropriate)
❓ Handles expiration of auth credentials. Refresh if possible or print correct error and fail setup.
❓ If based on a config entry, should trigger a new config entry flow to re-authorize.
❓ Handles internet unavailable. Log a warning once when unavailable, log once when reconnected.
❓ Handles device/service unavailable. Log a warning once when unavailable, log once when reconnected.
❌ Set available property to False if appropriate (docs)
✅ Entities have unique ID (if available) (docs)

Even though I haven't checked on the question marks, I still see missing things for a silver 🥈

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. I will remove it. I have still a lot of stuff to do it seems.
Sadly, it seems that existing component with qa scale don't respect these rules. Do you know a good one?

Copy link
Member

Choose a reason for hiding this comment

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

The QA scale should be correct in the documentation. If you feel like one is incorrect, feel free to raise an issue or open a PR.

Hue & deCONZ are probably good examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the information.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

This looks ready to merge to me!
Thanks, @tetienne 🎉

@frenck frenck removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Jun 18, 2019
@frenck frenck merged commit ac342c9 into home-assistant:next Jun 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants