Add Overkiz documentation for new integration by iMicknl · Pull Request #20841 · home-assistant/home-assistant.io

iMicknl · 2021-12-23T18:08:05Z

Proposed change

Adds the first version of the Overkiz documentation, for the sensor entity.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logo's and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Add Overkiz integration (with base + sensor entity) core#62640
Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/2478/files
This PR fixes or closes issue:

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

probot-home-assistant · 2021-12-23T18:08:10Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.
_{^{(message by DocsTargetBranch)}}

bdraco

The somfy changes should probably be in a separate PR after this is merged since this PR is really about overkiz and not somfy

bdraco · 2021-12-24T20:30:31Z

@iMicknl For the rest of these, please do one docs PR to match up with the core PR so they are easier to keep track of. Thanks 👍

frenck

@iMicknl Please address these review comments in a new PR.

Thanks 👍

frenck · 2021-12-27T07:14:19Z

+  - Button
+  - Lock
+  - Number
+ha_release: 2022.1.0


This version is incorrect. It should tag the major version and above all 2022.1 won't be released.

Please open a PR to correct this to 2022.2

frenck · 2021-12-27T07:17:28Z

+
+**Execution queue is full on gateway: #xxxx-xxxx-xxxx (soft limit: 10)**
+
+The Overkiz has a limit of 10 actions that can be executed in parallel. Currently this can only be solved by adding a time-out in between your executions, where you need to take the execution time into account.


This sounds like a bug to me, and something that should not be solved in the documentation.

We should not have to burden the end-user with these kinds of things.

@iMicknl AFAICT this is a limitation on Somfy's side with no clear solution. Feel free to reach out on discord to discuss ideas to work around this implementation flaw (on Somfy's side).

frenck · 2021-12-27T09:55:15Z

+  - number
+---
+
+The Overkiz (by Somfy) integration platform is used by many different vendors, like Somfy, Hitachi and Atlantic. This integration will allow users to integrate their devices into Home Assistant using the Overkiz API.


like Somfy, Hitachi and Atlantic -> like Somfy, Hitachi, and Atlantic

frenck · 2021-12-27T09:56:35Z

+
+**Server busy, please try again later. (Too many executions)**
+
+During peak hours, it could happen that the Overkiz platform is unable to execute your command. The integration will try to retry this command, however this is not guaranteed to succeed. 


Space after succeed.

Missing comma after however: this command, however, this is

frenck · 2021-12-27T09:57:30Z

+
+### Z-Wave, Hue and Sonos not supported
+
+Even though most Overkiz hubs supports adding Z-Wave, Hue and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant which are more stable and feature rich.


supports -> support

Z-Wave, Hue and Sonos devices -> Z-Wave, Hue, and Sonos devices

feature rich -> feature-rich`

frenck · 2021-12-27T09:58:37Z

+
+### Internet connectivity required
+
+This integration communicates via the cloud based Overkiz API, since Overkiz doesn't expose a local API on their hubs. If you are only using Somfy IO compatible devices, you could purchase a Velux KLF200 hub and use to [the Velux integration](/integrations/velux/) which has a local API.


cloud based -> cloud-based

Misplaced to, remove it: Velux KLF200 hub and use to -> Velux KLF200 hub and use

Update Overkiz documentation

cfd2cab

homeassistant added the cla-signed label Dec 23, 2021

probot-home-assistant Bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Dec 23, 2021

probot-home-assistant Bot assigned iMicknl Dec 23, 2021

probot-home-assistant Bot added the next This PR goes into the next branch label Dec 23, 2021

iMicknl mentioned this pull request Dec 23, 2021

Add Overkiz integration (with base + sensor entity) home-assistant/core#62640

Merged

22 tasks

Update wording

cd038d5

probot-home-assistant Bot added the has-parent This PR has a parent PR in another repo label Dec 23, 2021

iMicknl mentioned this pull request Dec 23, 2021

Add Overkiz brand for new core integration home-assistant/brands#2478

Merged

11 tasks

frenck added the parent-merged The parent PR has been merged already label Dec 23, 2021

This was referenced Dec 24, 2021

Add lock entity to Overkiz integration home-assistant/core#62713

Merged

Add button entity to Overkiz integration home-assistant/core#62719

Merged

bdraco requested changes Dec 24, 2021

View reviewed changes

iMicknl added 2 commits December 24, 2021 14:11

Update categories and platforms

851a6ef

Revert "Update Overkiz documentation"

a5d3cd6

bdraco mentioned this pull request Dec 24, 2021

Add number entity to Overkiz integration home-assistant/core#62732

Merged

22 tasks

bdraco approved these changes Dec 24, 2021

View reviewed changes

bdraco merged commit d26c8ed into home-assistant:next Dec 24, 2021

probot-home-assistant Bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Dec 24, 2021

github-actions Bot locked and limited conversation to collaborators Dec 25, 2021

iMicknl deleted the overkiz/base_and_sensor_docs branch December 27, 2021 09:55

frenck reviewed Dec 27, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Overkiz documentation for new integration#20841

Add Overkiz documentation for new integration#20841
bdraco merged 4 commits intohome-assistant:nextfrom
iMicknl:overkiz/base_and_sensor_docs

iMicknl commented Dec 23, 2021 •

edited

Loading

Uh oh!

probot-home-assistant Bot commented Dec 23, 2021

Uh oh!

bdraco left a comment

Uh oh!

bdraco commented Dec 24, 2021

Uh oh!

frenck left a comment

Uh oh!

frenck Dec 27, 2021

Uh oh!

frenck Dec 27, 2021 •

edited

Loading

Uh oh!

bdraco Dec 27, 2021 •

edited

Loading

Uh oh!

frenck Dec 27, 2021

Uh oh!

frenck Dec 27, 2021

Uh oh!

frenck Dec 27, 2021

Uh oh!

frenck Dec 27, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		Execution queue is full on gateway: #xxxx-xxxx-xxxx (soft limit: 10)

		The Overkiz has a limit of 10 actions that can be executed in parallel. Currently this can only be solved by adding a time-out in between your executions, where you need to take the execution time into account.


		Server busy, please try again later. (Too many executions)

		During peak hours, it could happen that the Overkiz platform is unable to execute your command. The integration will try to retry this command, however this is not guaranteed to succeed.


		### Z-Wave, Hue and Sonos not supported

		Even though most Overkiz hubs supports adding Z-Wave, Hue and Sonos devices, this isn't supported in the Overkiz integration. All these platforms have native integrations in Home Assistant which are more stable and feature rich.


		### Internet connectivity required

		This integration communicates via the cloud based Overkiz API, since Overkiz doesn't expose a local API on their hubs. If you are only using Somfy IO compatible devices, you could purchase a Velux KLF200 hub and use to [the Velux integration](/integrations/velux/) which has a local API.

Uh oh!

Conversation

iMicknl commented Dec 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

probot-home-assistant Bot commented Dec 23, 2021

Uh oh!

bdraco left a comment

Choose a reason for hiding this comment

Uh oh!

bdraco commented Dec 24, 2021

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bdraco Dec 27, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021

Choose a reason for hiding this comment

Uh oh!

frenck Dec 27, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iMicknl commented Dec 23, 2021 •

edited

Loading

frenck Dec 27, 2021 •

edited

Loading

bdraco Dec 27, 2021 •

edited

Loading