Add Broadlink cover platform #30156

embak · 2019-12-22T22:42:22Z

Description:

This PR introduces a new platform for controlling IR/RF covers using 'Broadlink' implementation for RM devices. I know, we already have the 'Broadlink' switch platform and 'Template Cover' that can be combined to do pretty much the same. I consider this an enhancement to the excellent work done by mjg59 and Danielhiversen.

This platform introduces the following improvements:

Instead of being hidden behind switches, the Broadlink cover is a fully integrated HA cover. As a result, only a single component is needed instead of 3 ( 2 switches+1 cover template) for a cover with up / down / stop control.
When provided with the opening and closing time configuration parameters, this platform handle position control. This is an 'optimistic mode' implementation, as the cover position is maintained internally. This time based control is fully integrated with the UI and more responsive.
Previously custom automations where required to achieve timer based position control. Resulting position precision is within 0,5 sec. The estimated cover position is adjusted accordingly.
Travelling can be stopped at any time and the resulting position is also returned.
As such it integrate seamlessly like the other regular cover in scenes or automations.
Support for main cover and tilt.

I successfully used this cover platform, as a custom component, trough UI, scenes, automations and voice control for more than 9 months with 4 RF covers.

Pull request with documentation for home-assistant.io: home-assistant/home-assistant.io#11517

Example entry for `configuration.yaml` :

cover:
  - platform: broadlink
    host: IP_ADDRESS
    mac: MAC_ADDRESS
    timeout: 10
    covers:
      # Cover without position control.
      dining_room_window:
        friendly_name: "Dining room window"
        command_open:  'sgOEAwwYDBgMGwYDBgLGRcNCgMGQsYGAAF3AAAAAA='
        command_close: 'sgOEAwsZCxDAwYDBgYDBcNDBcMGBgMGAAF3AAAAAA='
        command_stop:  'sgSEYFw0MFxgNCxkerghuhttgXDAwYGAAF3AAAAAA='
      # Cover with position control. 
      kitchen_window:
        friendly_name: "Kitchen Window"
        command_open:  'sgBuAQwYDBgMGBgMDBgMFMGAwYDBgMDAAF3AAAAAAAAAAAAAA='
        command_close: 'sgAeAQ0XDRcNFw0WDRcZCNFCxkLGQsNFw0ABdwAAAAAAAAAA'
        command_stop:  'sgDgAAwYFw0XDQsGA0LGYDAwMFxgNCxgYAAXcAAAAAAAAAAA='
        opening_time: 9.5
        closing_time: 9
      # Cover with position and tilt open / close control
      living_room_window:
        friendly_name: "Living Room Window"
        command_open:  'sgCwAaBRNQsVCwsWChYKFgsVCwwUFgsF3AAAAAAAAAAA'
        command_close: 'sgByAgsVCxUWCwsVDxYLFRULFcgyhCxUWAAAAAAAAAAA'
        command_stop:  'sgDsABULFgoWCgwVFRYULFQdVFgoMFBYAAAAAAAAAAAA'
        opening_time: 18
        closing_time: 12
        tilt_command_open: 'sgOEAwwYDBgMGBwLGQsYGAwMGAwYDBgMGBcNAAAA'
        tilt_command_close: 'sgDsABULFgoWCgoLFRQwdrVFgoMFBYAAAAAAAAAA'```

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

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.

homeassistant · 2019-12-22T22:42:24Z

Hi @embak,

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!

probot-home-assistant · 2019-12-22T22:42:28Z

Hey there @Danielhiversen, @felipediel, mind taking a look at this pull request as its been labeled with a integration (broadlink) you are listed as a codeowner for? Thanks!

frenck · 2019-12-23T11:49:46Z

Thank you for your contribution thus far! 🎖 Since this is a significant contribution, we would appreciate you'd added yourself to the list of code owners for this integration. ❤️

Please, add your GitHub username to the manifest.json of this integration.

For more information about "code owners", see: Architecture Decision Record 0008: Code owners.

embak · 2019-12-23T15:53:57Z

Thank you for your contribution thus far! 🎖 Since this is a significant contribution, we would appreciate you'd added yourself to the list of code owners for this integration. ❤️

Please, add your GitHub username to the manifest.json of this integration.

For more information about "code owners", see: Architecture Decision Record 0008: Code owners.

Done. Thanks.

stale · 2020-03-21T16:27:46Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

frenck · 2020-03-21T17:08:21Z

Thanks, stalebot, but this PR awaits an initial review from us.
Please keep open for now.

MartinHjelmare · 2020-04-15T00:56:02Z

homeassistant/components/broadlink/cover.py

+    }
+)
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(


We no longer accept additions or changes to the yaml config of integrations. See: https://github.com/home-assistant/architecture/blob/master/adr/0010-integration-configuration.md

This integration needs to be refactored to use a config flow and config entries.

https://developers.home-assistant.io/docs/config_entries_config_flow_handler

I am working on the refactor. Please hold this PR a little longer so we can integrate platforms.

When submitted last December this PR purpose was for a platform addition to the Broadlink integration. With this April 14 ADR10, my understanding is that the scope of this PR needs to be extended to a complete refactoring of the entire Broadlink integration to make it an UI Integration.
@felipediel is it what you meant by refactor.

@embak Home Assistant has changed and we need to adapt the Broadlink integration to be configured via config flow. I'm working on the update. When I'm done I'll be back here to help you adapt the code.

This PR will be refactored pending config flow implementation in the Broadlink integration. ( #36914 )

Can we in meantime close this PR and re-open when ready?

As we keep looking at things, that cannot move forward at this point, which is highly inefficient for us reviewers.

Thanks for considering 👍

stale · 2020-05-19T21:48:31Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

stale · 2020-06-23T05:24:23Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

stale · 2020-07-25T04:30:22Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

MartinHjelmare · 2020-07-25T08:48:00Z

Closing here for now. Ping me when we can move forward.

embak added 2 commits December 22, 2019 14:15

Add cover platform to Broadlink integration

d4c9b01

Merge branch 'dev' into broadlink-cover

689d0b8

embak requested a review from Danielhiversen as a code owner December 22, 2019 22:42

homeassistant added the cla-needed label Dec 22, 2019

probot-home-assistant bot added integration: broadlink new-platform labels Dec 22, 2019

project-bot bot added this to Needs review in Dev Dec 22, 2019

probot-home-assistant bot assigned Danielhiversen Dec 22, 2019

embak mentioned this pull request Dec 22, 2019

Add documentation for Broadlink cover platform home-assistant/home-assistant.io#11517

Closed

2 tasks

homeassistant added cla-signed and removed cla-needed labels Dec 22, 2019

embak added 3 commits December 23, 2019 09:46

Merge remote-tracking branch 'upstream/dev' into broadlink-cover

852baff

Addition to Broadlink's manifest codeowners

fcf7728

Update codeowners

5eeb342

springstan changed the title ~~Broadlink cover platform~~ Add Broadlink cover platform Jan 2, 2020

stale bot added the stale label Mar 21, 2020

stale bot removed the stale label Mar 21, 2020

MartinHjelmare requested changes Apr 15, 2020

View reviewed changes

Dev automation moved this from Needs review to Review in progress Apr 15, 2020

embak added 3 commits April 19, 2020 14:57

Keep up

075962d

Merge remote-tracking branch 'upstream/dev' into broadlink-cover

6173ec3

Keep up

773ce67

MartinHjelmare self-assigned this Apr 19, 2020

stale bot added stale and removed stale labels May 19, 2020

stale bot added stale and removed stale labels Jun 23, 2020

stale bot added the stale label Jul 25, 2020

MartinHjelmare closed this Jul 25, 2020

Dev automation moved this from Review in progress to Cancelled Jul 25, 2020

embak deleted the broadlink-cover branch August 9, 2020 18:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Broadlink cover platform #30156

Add Broadlink cover platform #30156

embak commented Dec 22, 2019 •

edited

Loading

homeassistant commented Dec 22, 2019

probot-home-assistant bot commented Dec 22, 2019

frenck commented Dec 23, 2019

embak commented Dec 23, 2019

stale bot commented Mar 21, 2020

frenck commented Mar 21, 2020

MartinHjelmare Apr 15, 2020

felipediel Apr 15, 2020

embak May 23, 2020

felipediel May 23, 2020

embak Jun 24, 2020

frenck Jun 24, 2020

stale bot commented May 19, 2020

stale bot commented Jun 23, 2020

stale bot commented Jul 25, 2020

MartinHjelmare commented Jul 25, 2020

Add Broadlink cover platform #30156

Add Broadlink cover platform #30156

Conversation

embak commented Dec 22, 2019 • edited Loading

Description:

Example entry for configuration.yaml :

Checklist:

homeassistant commented Dec 22, 2019

probot-home-assistant bot commented Dec 22, 2019

frenck commented Dec 23, 2019

embak commented Dec 23, 2019

stale bot commented Mar 21, 2020

frenck commented Mar 21, 2020

MartinHjelmare Apr 15, 2020

Choose a reason for hiding this comment

felipediel Apr 15, 2020

Choose a reason for hiding this comment

embak May 23, 2020

Choose a reason for hiding this comment

felipediel May 23, 2020

Choose a reason for hiding this comment

embak Jun 24, 2020

Choose a reason for hiding this comment

frenck Jun 24, 2020

Choose a reason for hiding this comment

stale bot commented May 19, 2020

stale bot commented Jun 23, 2020

stale bot commented Jul 25, 2020

MartinHjelmare commented Jul 25, 2020

embak commented Dec 22, 2019 •

edited

Loading

Example entry for `configuration.yaml` :