Introduce wiz_light integration for WiZ bulbs #44522

sbidy · 2020-12-25T17:23:56Z

Proposed change

A HA integration for WiZ Light bulbs (Phillips, SLV and more). The integration extents HA to communicate directly with this WiFi connected lights via async UDP calls. There is no Cloud or Web API needed for interaction with this lights.

The integration is designed async, including the UDP calls via pywizlight extension.

Supported Features:

Brightness
Color (RGB)
White Color Temperature
On/Off, Toggle
Effects
Bulb feature detection. Mapping up to 16 different bulb feature sets.

wiz_light GitHub // pywizlight

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml
light:
  - platform: wiz_light
    name: Name_Bulb_1
    host: 127.0.0.1
  - platform: wiz_light
    name: Name_Bulb_2
    host: 127.0.0.2

ConfigFlow is also available.

Additional information

This PR fixes or closes issue:
This PR is related to issue: Introduce wiz_light integration for WiZ bulbs #35132
Link to documentation pull request:

Checklist

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

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.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

[] No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

joncar · 2020-12-26T04:40:39Z

homeassistant/components/wiz_light/light.py

+    def read_bulblib():
+        """Read the library of bulbs from YAML."""
+        # fetch the location of the lib yaml
+        __location__ = os.path.realpath(


Is this roundabout way of getting the path necessary? I haven't tried it myself within HA's environment but __file__ is absolute in my command line experiments and the Python issue tracker indicates this should always be the case.

joncar · 2020-12-26T04:42:09Z

homeassistant/components/wiz_light/manifest.json

+{
+  "domain": "wiz_light",
+  "name": "WiZ Light Integration",
+  "documentation": "https://github.com/sbidy/wiz_light",


Documentation should point at HA's official docs since this is being integrated.

joncar · 2020-12-26T04:43:53Z

homeassistant/components/wiz_light/translations/en.json

@@ -0,0 +1,22 @@
+{


Your translation file has more/different values than the base strings.json file.

Good to know. Is it possible to generate these?

joncar · 2020-12-26T05:23:20Z

homeassistant/components/wiz_light/config_flow.py

+from homeassistant.const import CONF_IP_ADDRESS, CONF_NAME
+from homeassistant.data_entry_flow import AbortFlow
+
+from .const import DEFAULT_NAME, DOMAIN  # pylint: disable=unused-import


Both of these imports are used. Why does pylint need to be disabled?

I don't know why this pups up in the test stack. In my devcontainer pylint doesn't shows me an error.
Seems to be a false positive.

joncar · 2020-12-26T05:26:23Z

homeassistant/components/wiz_light/config_flow.py

+                    return self.async_create_entry(
+                        title=user_input[CONF_NAME], data=user_input
+                    )
+                return self.async_abort(reason="no_IP")


It would be more typical for a config flow to return the async_show_form with errors[CONF_IP_ADDRESS] = "no_IP" to allow the user to correct the problem.

joncar · 2020-12-26T05:37:00Z

tests/components/wiz_light/__init__.py

@@ -0,0 +1 @@
+"""Tests for the WiZ Light integration integration."""


I will be surprised if The Powers That Be approve this PR without any unit tests for the integration.

That's correct but there are almost no documentation how and what to test.
I will start to dig in the pytesing of HASS.

Please use our scaffold script to generate example code including tests for the config flow using best practices patterns.

I already used the script to generate the pattern. But overall there will no "test" generated.
The only docs for the testing I have found are here.

It does generate test code. Please try again.

No, it doesn't in the current dev branch via devcontainer. I also tried it with an "clean" demo integration. It also doesn't create a test. Only the init will be created.

I'll try to reproduce and create a test manually.

When I run this on dev branch (and answer the questions):

python -m script.scaffold integration

I get this output:

Integration code has been generated Added the following files: - homeassistant/components/wiz_light/manifest.json - homeassistant/components/wiz_light/config_flow.py - homeassistant/components/wiz_light/__init__.py - homeassistant/components/wiz_light/const.py Added the following tests: - tests/components/wiz_light/test_config_flow.py The next step is to look at the files and deal with all areas marked as TODO.

homeassistant/components/wiz_light/bulblibrary.yaml

craigcabrey · 2020-12-27T02:47:18Z

Testing this locally, I get the following error:

2020-12-26 18:45:11 ERROR (MainThread) [homeassistant.setup] Error during setup of component wiz_light
Traceback (most recent call last):
  File "/home/craigcabrey/Documents/core/homeassistant/setup.py", line 200, in _async_setup_component
    task = component.async_setup(hass, processed_config)  # type: ignore
TypeError: async_setup() takes 1 positional argument but 2 were given

It also seems to only allow adding one light at a time. Ideally, we should be able to add a bunch of lights at once (since otherwise it'll require adding a new integration each time).

caesar1987sk · 2020-12-27T07:11:40Z

It also seems to only allow adding one light at a time. Ideally, we should be able to add a bunch of lights at once (since otherwise it'll require adding a new integration each time).

It is possible to add multiple of them, I have integrated 2 wiz lights with this integration.

Edit: they are added using yaml not ui, maybe you mean this, not sure.

sbidy · 2020-12-30T19:59:11Z

It also seems to only allow adding one light at a time. Ideally, we should be able to add a bunch of lights at once (since otherwise it'll require adding a new integration each time).

It is possible to add multiple of them, I have integrated 2 wiz lights with this integration.

Edit: they are added using yaml not ui, maybe you mean this, not sure.

Yes, via config.yaml it is possible. But it should also be possible to add more than one per intergration.

@craigcabrey please run it and delete the test "Wiz Light" integration via web interface. This was added for testing from my side.

MartinHjelmare · 2020-12-31T11:13:08Z

Please make sure the build passes. Run hassfest and translations develop scripts and check the CI build error output. And add tests for the config flow. That's the minimum tests required.

sbidy · 2020-12-31T12:38:33Z

Close because of missing tests and issues with the branch. Reopen and create reference.

sbidy and others added 19 commits December 13, 2020 18:08

Add wiz_light base

53b2ba8

Update requirements

24480c8

Add MAC as unique ID for entry

f711933

Add wiz_light and config_flow

28d7d10

First working config_flow

e1ca3f9

Add legacy YAML support and add error handling.

80522ee

Update translation.

54c298c

Update translation and confi_flow

9d0e348

Remove switch because of some issues and testing.

3ca2803

Update pywizlight

47f390c

Update exception

4edd7f0

Merge branch 'dev' of https://github.com/sbidy/core into dev

dd02f35

Add exception and message

2992cbd

Bump pywizlight to v 0.3.7

2025578

Add timeout fix and validate user input

0bc175d

Sort imports and update - ready for pull

c3dc35a

Updated translation

84ba9f6

Updated bulblib with some types

365af3b

Update coveragerc

dc4ce5d

homeassistant added the cla-signed label Dec 25, 2020

probot-home-assistant bot added has-tests integration: wiz_light new-integration labels Dec 25, 2020

This was referenced Dec 25, 2020

Introduce wiz_light integration for WiZ bulbs #35132

Closed

Implement ConfigFlow sbidy/wiz_light#4

Closed

Pull request into homeassistant core timed out. sbidy/wiz_light#40

Closed

sbidy added 2 commits December 25, 2020 19:32

Add config_flow.py to .coveragerc. Fix spell error. Fix pylint.

ecce2c7

Format issues fixed.

9b1de0a

joncar reviewed Dec 26, 2020

View reviewed changes

MartinHjelmare requested changes Dec 26, 2020

View reviewed changes

homeassistant/components/wiz_light/bulblibrary.yaml Outdated Show resolved Hide resolved

sbidy added 3 commits December 30, 2020 21:45

Remove bulblib YAML, fix async_setup issue and string.json.

66f77fe

Code style changes.

5b37455

Fixing unused requirement.

600d993

sbidy requested a review from MartinHjelmare December 30, 2020 22:16

sbidy closed this Dec 31, 2020

github-actions bot locked and limited conversation to collaborators Jan 1, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce wiz_light integration for WiZ bulbs #44522

Introduce wiz_light integration for WiZ bulbs #44522

sbidy commented Dec 25, 2020 •

edited

Loading

joncar Dec 26, 2020

joncar Dec 26, 2020

joncar Dec 26, 2020

sbidy Dec 30, 2020 •

edited

Loading

joncar Dec 26, 2020

sbidy Dec 30, 2020 •

edited

Loading

joncar Dec 26, 2020

joncar Dec 26, 2020

sbidy Dec 30, 2020

MartinHjelmare Dec 30, 2020

sbidy Dec 30, 2020 •

edited

Loading

MartinHjelmare Dec 31, 2020

sbidy Dec 31, 2020

MartinHjelmare Dec 31, 2020

craigcabrey commented Dec 27, 2020

caesar1987sk commented Dec 27, 2020 •

edited

Loading

sbidy commented Dec 30, 2020

MartinHjelmare commented Dec 31, 2020

sbidy commented Dec 31, 2020

		@@ -0,0 +1 @@
		"""Tests for the WiZ Light integration integration."""

Introduce wiz_light integration for WiZ bulbs #44522

Introduce wiz_light integration for WiZ bulbs #44522

Conversation

sbidy commented Dec 25, 2020 • edited Loading

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbidy Dec 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbidy Dec 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sbidy Dec 30, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

craigcabrey commented Dec 27, 2020

caesar1987sk commented Dec 27, 2020 • edited Loading

sbidy commented Dec 30, 2020

MartinHjelmare commented Dec 31, 2020

sbidy commented Dec 31, 2020

sbidy commented Dec 25, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

sbidy Dec 30, 2020 •

edited

Loading

sbidy Dec 30, 2020 •

edited

Loading

sbidy Dec 30, 2020 •

edited

Loading

caesar1987sk commented Dec 27, 2020 •

edited

Loading