Add quality scale for WLED by mik-laj · Pull Request #155482 · home-assistant/core

mik-laj · 2025-10-30T04:40:22Z

Breaking change

Proposed change

Bronze

Silver

Gold

Platinum

async-dependency - Dependency is async
inject-websession - The integration dependency supports passing in a websession
strict-typing - Strict typing

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)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request:
Link to developer documentation pull request:
Link to frontend pull request:

Checklist

I understand the code I am submitting and can explain how it works.
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
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

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.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

home-assistant · 2025-10-30T04:40:30Z

Hey there @frenck, mind taking a look at this pull request as it has been labeled with an integration (wled) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of wled can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign wled Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

mik-laj · 2025-10-30T04:42:42Z

      "init": {
        "data": {
          "keep_master_light": "Add 'Main' control even with single LED segment"
+        },


For unknown reason, pytest started reporting the error:

FAILED tests/components/wled/test_config_flow.py::test_options_flow - Failed: Translation not found for wled: `options.step.init.data_description.keep_master_light`. Please add to homeassistant/components/wled/strings.json

data_description should be optional fields, but it is not always true.

They are not optional... just because it works without doesn't make them optional and it is a check that get introduced as part of the quality scale checks

I relied on the documentation which says it is optional.

https://developers.home-assistant.io/docs/data_entry_flow_index/#labels--descriptions

Since this is the entrypoint for users to start using an integration, we should make sure that the config flow is very user-friendly and understandable.
This means we should use the right selectors at the right place, validate the input where needed, and use data_description in the strings.json to give context about the input field.

https://github.com/home-assistant/developers.home-assistant/blob/12d3c35acfc873fb8b460ff0e9fdca3ed24d4dda/docs/core/integration-quality-scale/rules/config-flow.md?plain=1#L20-L21

I found another text that describes this, and it also doesn't say it's required explicitly. This could be interpreted as meaning that config flow should be user-friendly, and one way to do this is by using data_description.

I created a PR: #155572

Thank you also very much for explaining where this error message comes from.

Copilot

Pull Request Overview

This pull request implements the parallel-updates Silver tier quality scale requirement for the WLED integration. The changes add the PARALLEL_UPDATES constant to platform files that were missing it, bringing the integration into compliance with Silver tier quality scale rules.

Adds PARALLEL_UPDATES = 0 to button.py, sensor.py, and update.py platforms
Creates quality_scale.yaml tracking file documenting the integration's quality scale compliance status
Removes WLED from the exemption list in the quality scale validation script

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
script/hassfest/quality_scale.py	Removes WLED from the parallel-updates rule exemption list
homeassistant/components/wled/quality_scale.yaml	Adds comprehensive quality scale tracking file with rule status for Bronze, Silver, Gold, and Platinum tiers
homeassistant/components/wled/button.py	Adds `PARALLEL_UPDATES = 0` constant with explanatory comment
homeassistant/components/wled/sensor.py	Adds `PARALLEL_UPDATES = 0` constant with explanatory comment
homeassistant/components/wled/update.py	Adds `PARALLEL_UPDATES = 0` constant with explanatory comment

Copilot · 2025-10-30T04:49:57Z

+# Coordinator is used to centralize the data updates
+PARALLEL_UPDATES = 0


The comment "Coordinator is used to centralize the data updates" doesn't explain why PARALLEL_UPDATES = 0 was chosen. According to the coding guidelines, PARALLEL_UPDATES = 0 means unlimited concurrent updates and is appropriate for coordinator-based platforms. Consider clarifying this in the comment, such as: "# Coordinator-based platform, unlimited parallel updates (PARALLEL_UPDATES = 0)"

Copilot · 2025-10-30T04:49:58Z

+# Coordinator is used to centralize the data updates
+PARALLEL_UPDATES = 0


The comment "Coordinator is used to centralize the data updates" doesn't explain why PARALLEL_UPDATES = 0 was chosen. According to the coding guidelines, PARALLEL_UPDATES = 0 means unlimited concurrent updates and is appropriate for coordinator-based platforms. Consider clarifying this in the comment, such as: "# Coordinator-based platform, unlimited parallel updates (PARALLEL_UPDATES = 0)"

Copilot · 2025-10-30T04:49:58Z

+# Coordinator is used to centralize the data updates
+PARALLEL_UPDATES = 0


The comment "Coordinator is used to centralize the data updates" doesn't explain why PARALLEL_UPDATES = 0 was chosen. According to the coding guidelines, PARALLEL_UPDATES = 0 means unlimited concurrent updates and is appropriate for coordinator-based platforms. Consider clarifying this in the comment, such as: "# Coordinator-based platform, unlimited parallel updates (PARALLEL_UPDATES = 0)"

mik-laj · 2025-10-30T10:28:59Z

+  entity-translations: done
+  exception-translations: todo
+  icon-translations: done
+  reconfiguration-flow: todo


PR is ready: https://github.com/home-assistant/core/pull/155491/files

mik-laj · 2025-10-30T10:29:40Z

+    comment: |
+      I see two problems:
+      - Unsupported WLED version.
+      - MAC address mismatch e.g. we connect to the device, but


This problem is covered by: https://github.com/home-assistant/core/pull/155491/files

mik-laj · 2025-10-30T10:34:43Z

+    comment: This integration does not have custom service actions.
+  docs-high-level-description: done
+  docs-installation-instructions: done
+  docs-removal-instructions: todo


PR is ready: home-assistant/home-assistant.io#41534

Merged. I bumped quality scale to bronze now.

epenet

Please move all code changes to separate PRs
Keep this PR for ONLY the quality_scale.yaml + quality_scale.py changes

home-assistant · 2025-10-31T10:40:53Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

mik-laj · 2025-10-31T23:29:00Z

Please move all code changes to separate PRs

Done.
#155573
#155572
#155571

I'll do a rebase once these changes are merged so I don't have to bother updating the quality-scale.yaml file multiple times as these changes are trivial.

joostlek · 2025-12-02T23:26:54Z

+    comment: |
+      This integration has a fixed single device.
+  entity-category: done
+  entity-device-class: done


led count could receive unit ofmeasurement for LED

joostlek · 2025-12-02T23:27:40Z

@@ -0,0 +1,78 @@
+rules:


maybe the nightlight could eventually become their own entity

I'm not sure I understand. "Nightlight" is a timer that turns the light off after a certain time, so the switch type seems fine to me.

Sorry, there are extra state attributes that might warrant their own entity

I'm not sure if many people use the nightlight in WLED if the same can be done in HA. This entity mainly collects history when someone triggered it from the WLED UI.

joostlek · 2025-12-02T23:28:16Z

+  config-entry-unloading: done
+  docs-configuration-parameters: done
+  docs-installation-parameters: todo
+  entity-unavailable: done


@property def available(self) -> bool: """Return True if entity is available.""" try: self.coordinator.data.state.segments[self._segment] except KeyError: return False return super().available

This can just be an if .. in .. check

joostlek · 2025-12-02T23:29:47Z

+  appropriate-polling: done
+  brands: done
+  common-modules: done
+  config-flow-test-coverage: done


test_connection_error and test_unsupported_version_error should end in CREATE_ENTRY

joostlek · 2025-12-02T23:30:38Z

+    status: exempt
+    comment: |
+      This integration does not require authentication.
+  test-coverage: done


test_websocket_already_connected can use the freezer (more tests in the test_coordinator file).

joostlek · 2025-12-02T23:32:05Z

+    status: exempt
+    comment: |
+      This integration does not require authentication.
+  test-coverage: done


The light platform could use snapshot tests to actually get a snapshot of every fixture light. (not a blocker, just a potential improvement)

The sensor platform as well

joostlek · 2025-12-02T23:33:26Z

+    status: exempt
+    comment: |
+      This integration does not require authentication.
+  test-coverage: done


test_time = datetime(2019, 11, 11, 9, 10, 32, tzinfo=dt_util.UTC) instead, we should use

@pytest.mark.freeze_time("2023-10-21")

joostlek · 2025-12-02T23:34:40Z

@@ -0,0 +1,78 @@
+rules:


The location of the WLED repo has changed btw, so we should update the release URL

joostlek · 2025-12-02T23:35:03Z

@@ -0,0 +1,78 @@
+rules:
+  # Bronze
+  action-setup: done


but the integration doesn't have actions :)

joostlek · 2025-12-02T23:35:15Z

+  action-exceptions:
+    status: exempt
+    comment: This integration does not have custom service actions.


turning on the light also counts as an action for example

Changes split

Copilot AI review requested due to automatic review settings October 30, 2025 04:40

mik-laj requested review from a team and frenck as code owners October 30, 2025 04:40

home-assistant Bot added cla-signed Hacktoberfest integration: wled quality-scale labels Oct 30, 2025

home-assistant Bot assigned frenck Oct 30, 2025

home-assistant Bot added the Quality Scale: No score label Oct 30, 2025

mik-laj commented Oct 30, 2025

View reviewed changes

Copilot AI reviewed Oct 30, 2025

View reviewed changes

mik-laj commented Oct 30, 2025

View reviewed changes

epenet previously requested changes Oct 31, 2025

View reviewed changes

home-assistant Bot marked this pull request as draft October 31, 2025 10:40

mik-laj commented Oct 31, 2025

View reviewed changes

Comment thread homeassistant/components/wled/quality_scale.yaml Outdated

mik-laj force-pushed the wled-quality-scale-2 branch 2 times, most recently from 354b6bd to ee28068 Compare November 5, 2025 00:20

mik-laj mentioned this pull request Dec 2, 2025

Handle unsupported version in WLED #157778

Merged

21 tasks

mik-laj and others added 3 commits December 2, 2025 23:21

Add quality scale for WLED

b5303a6

Update quality_scale.yaml to mark tasks as done

b8e382b

fixup! Update quality_scale.yaml to mark tasks as done

461bba3

mik-laj force-pushed the wled-quality-scale-2 branch from f55b694 to 461bba3 Compare December 2, 2025 23:22

joostlek requested changes Dec 2, 2025

View reviewed changes

joostlek added the new-feature label Dec 2, 2025

fixup! fixup! Update quality_scale.yaml to mark tasks as done

4dcf996

fixup! fixup! fixup! Update quality_scale.yaml to mark tasks as done

76b64cd

mik-laj marked this pull request as ready for review December 3, 2025 00:14

home-assistant Bot requested review from epenet and joostlek December 3, 2025 00:14

joostlek approved these changes Dec 3, 2025

View reviewed changes

joostlek merged commit 6f6e9b8 into home-assistant:dev Dec 3, 2025
36 checks passed

mik-laj mentioned this pull request Dec 3, 2025

Improve tests in WLED #157799

Merged

21 tasks

github-actions Bot locked and limited conversation to collaborators Dec 4, 2025

	try:
	device = await self._async_get_device(user_input[CONF_HOST])
	except WLEDConnectionError:
	errors["base"] = "cannot_connect"
	else:

	await self.async_set_unique_id(
	device.info.mac_address, raise_on_progress=False
	)
	self._abort_if_unique_id_configured(
	updates={CONF_HOST: user_input[CONF_HOST]}
	)

	async def async_unload_entry(hass: HomeAssistant, entry: WLEDConfigEntry) -> bool:
	"""Unload WLED config entry."""
	if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
	coordinator = entry.runtime_data

	# Ensure disconnected and cleanup stop sub
	await coordinator.wled.disconnect()
	if coordinator.unsub:
	coordinator.unsub()

	return unload_ok

	def device_info(self) -> DeviceInfo:
	"""Return device information about this WLED device."""
	return DeviceInfo(
	connections={
	(CONNECTION_NETWORK_MAC, self.coordinator.data.info.mac_address)
	},
	identifiers={(DOMAIN, self.coordinator.data.info.mac_address)},
	name=self.coordinator.data.info.name,
	manufacturer=self.coordinator.data.info.brand,
	model=self.coordinator.data.info.product,
	sw_version=str(self.coordinator.data.info.version),
	hw_version=self.coordinator.data.info.architecture,
	configuration_url=f"http://{self.coordinator.wled.host}",
	)

	SCAN_INTERVAL = timedelta(seconds=10)
	RELEASES_SCAN_INTERVAL = timedelta(hours=3)

		# Coordinator is used to centralize the data updates
		PARALLEL_UPDATES = 0

Uh oh!

Conversation

mik-laj commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Bronze

Silver

Gold

Platinum

Type of change

Additional information

Checklist

Uh oh!

home-assistant Bot commented Oct 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epenet Oct 31, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 30, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epenet left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant Bot commented Oct 31, 2025

Uh oh!

mik-laj commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

mik-laj commented Oct 30, 2025 •

edited

Loading

epenet Oct 31, 2025 •

edited

Loading

mik-laj commented Oct 31, 2025 •

edited

Loading