Vesync Display Switch Feature #137493

cdnninja · 2025-02-06T00:25:56Z

Proposed change

Adds the screen switch for both fan and humidifier device. Tested on my physical humidifier and air purifier.

This also consolidates on/off testing so it can run parameter based tests.

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: Vesync Switch for Display home-assistant.io#37334
Link to developer documentation pull request:
Link to frontend 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
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.

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-02-06T00:26:04Z

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

Code owner commands

Code owners of vesync 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 vesync 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.

homeassistant/components/vesync/strings.json

homeassistant/components/vesync/switch.py

home-assistant/core#137493

iprak · 2025-02-13T16:59:29Z

Can we can use display_state property which other types of devices implement as well?

I was originally working on this (dev...iprak:core-fork:auto-stop-display-switches-for-humidifier) when I noticed it to be partially implemented. I got that fixed (webdjoe/pyvesync#293) but it hasn't been released.

cdnninja · 2025-02-13T17:17:26Z

I have updated - I will put to draft until that release is done and merged.

patricknelson · 2025-02-17T06:44:47Z

Looking forward to this one! I’d love to automate switching off that bright display at night.

Edit: Feature request in the community forums: https://community.home-assistant.io/t/vesync-set-the-night-light-on-levoit-air-purifiers/367463

cdnninja · 2025-02-17T20:41:43Z

This is ready for review. Two notes:

It works on my humidifier, when in sleep mode the API rejects it. Only works in Auto or Normal. I updated the turn on off logic to throw an exception when it falls. Otherwise it fails silently. Since we don't have debug support no one would know.
My 131S doesn't work to toggle, it shows state fine. This is an API library issue though. I thought this worked last week. Server is responding with:

2025-02-17 13:31:26,884 - DEBUG - API response: 

  {
  "code": 4001007,
  "msg": "request parameter invalid",
  "traceId": "1739824287128",
  "result": null
}

I will dig into this. I personally don't think this is a deal breaker as other device models work. I have created an issue within the library and will spend some future time on that.

cdnninja · 2025-02-24T17:40:21Z

Solves 131 in webdjoe/pyvesync#305.

joostlek · 2025-02-25T12:52:28Z

tests/components/vesync/test_switch.py

+@pytest.mark.parametrize(
+    ("api_response", "expectation"),
+    [(False, pytest.raises(HomeAssistantError)), (True, NoException)],
+)
+async def test_turn_on_display(
+    hass: HomeAssistant,
+    humidifier_config_entry: MockConfigEntry,
+    api_response: bool,
+    expectation,
+) -> None:
+    """Test turn_on method."""
+
+    # turn_on_display returns False indicating failure in which case switch.turn_on_display
+    # raises HomeAssistantError.
+    with (
+        expectation,
+        patch(
+            "pyvesync.vesyncfan.VeSyncHumid200300S.turn_on_display",
+            return_value=api_response,
+        ) as method_mock,
+    ):
+        with patch(
+            "homeassistant.components.vesync.switch.VeSyncSwitchEntity.schedule_update_ha_state"
+        ) as update_mock:
+            await hass.services.async_call(
+                SWITCH_DOMAIN,
+                SERVICE_TURN_ON,
+                {ATTR_ENTITY_ID: ENTITY_SWITCH_DISPLAY},
+                blocking=True,
+            )
+
+        await hass.async_block_till_done()
+        method_mock.assert_called_once()
+        update_mock.assert_called_once()
+
+
+@pytest.mark.parametrize(
+    ("api_response", "expectation"),
+    [(False, pytest.raises(HomeAssistantError)), (True, NoException)],
+)
+async def test_turn_off_display(
+    hass: HomeAssistant,
+    humidifier_config_entry: MockConfigEntry,
+    api_response: bool,
+    expectation,
+) -> None:
+    """Test turn_off method."""
+
+    # turn_off_display returns False indicating failure in which case switch.turn_off_display
+    # raises HomeAssistantError.
+    with (
+        expectation,
+        patch(
+            "pyvesync.vesyncfan.VeSyncHumid200300S.turn_off_display",
+            return_value=api_response,
+        ) as method_mock,
+    ):
+        with patch(
+            "homeassistant.components.vesync.switch.VeSyncSwitchEntity.schedule_update_ha_state"
+        ) as update_mock:
+            await hass.services.async_call(
+                SWITCH_DOMAIN,
+                SERVICE_TURN_OFF,
+                {ATTR_ENTITY_ID: ENTITY_SWITCH_DISPLAY},
+                blocking=True,
+            )
+
+        await hass.async_block_till_done()
+        method_mock.assert_called_once()
+        update_mock.assert_called_once()


I think it's more useful and logical to switch the way we parametrize. Have 1 test for all the failing service calls, and have 1 test for all the working service calls, since the only thing you have to change is the function called and the service name.

To confirm are you thinking a consolidated test across all platforms so also parametrize a few other values or just within the platform?

home-assistant · 2025-02-25T12:52:33Z

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.

cdnninja · 2025-02-27T19:15:19Z

I have updated the tests to focus on parameters. A single fixture now can setup any device. The on_off tests in turn can run on multiple platforms.

This PR is required before my other ones with this issue as it holds the core test structure. Others will now just adjust the dictionary to add more tests.

Let me know if off/on should be two tests or if okay within the same test like it is right now.

This reverts commit f5b0b91.

This reverts commit 72757ec.

This reverts commit 8aabba6.

This reverts commit af346e5.

t0mc1k · 2025-03-14T23:37:31Z

Hello. Light control on CORE200S does not work.

"select/select_option. 'VeSyncAirBypass' object has no attribute 'set_night_light_brightness'

iprak · 2025-03-15T01:08:55Z

Hello. Light control on CORE200S does not work.

"select/select_option. 'VeSyncAirBypass' object has no attribute 'set_night_light_brightness'

This issue is logged here - #140236

cdnninja · 2025-03-19T14:56:55Z

@joostlek tests have been updated. Please let me know if this matches the goal. If so I will update the tests on the other PRs.

jcefoli · 2025-03-25T03:11:00Z

Not sure if this is the proper place for this, but with all the recent refactors, I found an issue with an older Voltson ESW01outlet, which is of device_type "wifi-switch-1.3" with firmware version 2.125. Home Assistant can no longer retrieve the power state of this plug, nor toggle it... (My identical looking plugs that are working fine report in as "ESW03-USA" (firmware 1.1.30).

I'm not a python dev, so I have no idea how to provide more info or help, but I did some basic tests with the newest released pyvesync library and was able to toggle that plug state and had no issue controlling all of my plugs directly via a simplified test case.

The only differences I can see are when I dumped both plug objects.

For device_type: ESW03-USA, the cid is a random string.
For device_type: wifi-switch-1.3, the cid is the same as the UUID

Let me know how I can provide more info or what the process is if this needs to be created as a separate issue

patricknelson · 2025-03-25T03:17:53Z

@jcefoli I don't think so. See top of the issue:

Adds the screen switch for both fan and humidifier device. Tested on my physical humidifier and air purifier.

In this case, I think it's just specific to humidifers and purifiers (e.g. like the Levoit 131S, see code). I think the "switch" in this case is in reference to the software switch presented by HA, not a physical wifi switch device.

cdnninja · 2025-03-25T03:25:16Z

Not sure if this is the proper place for this, but with all the recent refactors, I found an issue with an older Voltson ESW01outlet, which is of device_type "wifi-switch-1.3" with firmware version 2.125. Home Assistant can no longer retrieve the power state of this plug, nor toggle it... (My identical looking plugs that are working fine report in as "ESW03-USA" (firmware 1.1.30).

I'm not a python dev, so I have no idea how to provide more info or help, but I did some basic tests with the newest released pyvesync library and was able to toggle that plug state and had no issue controlling all of my plugs directly via a simplified test case.

The only differences I can see are when I dumped both plug objects.

For device_type: ESW03-USA, the cid is a random string. For device_type: wifi-switch-1.3, the cid is the same as the UUID

Let me know how I can provide more info or what the process is if this needs to be created as a separate issue

This is a new feature that hasn't been merged yet. Please open an issue under the issues tab and we can take a look.

joostlek · 2025-03-25T09:37:24Z

tests/components/vesync/snapshots/test_switch.ambr

+    'last_changed': <ANY>,
+    'last_reported': <ANY>,
+    'last_updated': <ANY>,
+    'state': 'unavailable',


Why is this one unavailable? It might sound like there's a bug here?

I think you are right. I adjusted this so it fails while we figure this out. I think a test has an issue as I own a 131 and it works. I updated some of the json files as they seemed incorrect without luck. @iprak thoughts?

Screen Switch

a73e4ac

home-assistant bot added cla-signed has-tests integration: vesync new-feature small-pr PRs with less than 30 lines. by-code-owner Quality Scale: No score labels Feb 6, 2025

Update test_init.py

a723b88

iprak suggested changes Feb 6, 2025

View reviewed changes

homeassistant/components/vesync/strings.json Show resolved Hide resolved

homeassistant/components/vesync/switch.py Outdated Show resolved Hide resolved

cdnninja changed the title ~~Vesync Screen Switch Feature~~ Vesync Display Switch Feature Feb 6, 2025

cdnninja added 2 commits February 6, 2025 01:20

Name Change to Display

9bef2ed

Revert force update

9b47a78

cdnninja added a commit to cdnninja/home-assistant.io that referenced this pull request Feb 6, 2025

Add Vesync Switch for Display

dc048a2

home-assistant/core#137493

cdnninja mentioned this pull request Feb 6, 2025

Vesync Switch for Display home-assistant/home-assistant.io#37334

Draft

8 tasks

Remove name - duplicate of translation key

8c07ec7

cdnninja requested a review from iprak February 13, 2025 16:51

Merge branch 'dev' into screenswitch

1223519

cdnninja marked this pull request as draft February 13, 2025 17:17

cdnninja added 2 commits February 13, 2025 17:17

Use display_state instead of details

40a0ff6

Reduce to single description

cacd8e5

cdnninja added 2 commits February 17, 2025 13:08

Merge branch 'dev' into screenswitch

c9bb248

Fix tests

82f2745

cdnninja marked this pull request as ready for review February 17, 2025 20:33

Update switch to reflect errors

99742c6

joostlek requested changes Feb 25, 2025

View reviewed changes

home-assistant bot marked this pull request as draft February 25, 2025 12:52

cdnninja added 2 commits February 27, 2025 18:58

Consolidate tests

af346e5

Remove unneeded import

8aabba6

cdnninja marked this pull request as ready for review February 27, 2025 19:03

home-assistant bot requested review from iprak and joostlek February 27, 2025 19:03

Rename and humidifer test correction

72757ec

This was referenced Feb 27, 2025

Refactor fan in vesync #135744

Draft

Update Vesync light state after on / off commands #135958

Draft

cdnninja added 5 commits February 27, 2025 19:26

case

f5b0b91

Revert "case"

5715dd6

This reverts commit f5b0b91.

Revert "Rename and humidifer test correction"

f934574

This reverts commit 72757ec.

Revert "Remove unneeded import"

e237a55

This reverts commit 8aabba6.

Revert "Consolidate tests"

c97d909

This reverts commit af346e5.

Test Corrections, Typo

68da245

joostlek requested changes Mar 25, 2025

View reviewed changes

home-assistant bot marked this pull request as draft March 25, 2025 09:39

cdnninja added 3 commits March 28, 2025 01:08

Update 131 tests

90009b5

fixed test

d44e659

snapshot Update

47ccd05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vesync Display Switch Feature #137493

Vesync Display Switch Feature #137493

cdnninja commented Feb 6, 2025 •

edited

Loading

home-assistant bot commented Feb 6, 2025

iprak commented Feb 13, 2025

cdnninja commented Feb 13, 2025

patricknelson commented Feb 17, 2025 •

edited

Loading

cdnninja commented Feb 17, 2025 •

edited

Loading

cdnninja commented Feb 24, 2025

joostlek Feb 25, 2025

cdnninja Feb 26, 2025

home-assistant bot commented Feb 25, 2025

cdnninja commented Feb 27, 2025

t0mc1k commented Mar 14, 2025

iprak commented Mar 15, 2025

cdnninja commented Mar 19, 2025

jcefoli commented Mar 25, 2025

patricknelson commented Mar 25, 2025

cdnninja commented Mar 25, 2025

joostlek Mar 25, 2025

cdnninja Mar 28, 2025

Vesync Display Switch Feature #137493

Are you sure you want to change the base?

Vesync Display Switch Feature #137493

Conversation

cdnninja commented Feb 6, 2025 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot commented Feb 6, 2025

iprak commented Feb 13, 2025

cdnninja commented Feb 13, 2025

patricknelson commented Feb 17, 2025 • edited Loading

cdnninja commented Feb 17, 2025 • edited Loading

cdnninja commented Feb 24, 2025

joostlek Feb 25, 2025

Choose a reason for hiding this comment

cdnninja Feb 26, 2025

Choose a reason for hiding this comment

home-assistant bot commented Feb 25, 2025

cdnninja commented Feb 27, 2025

t0mc1k commented Mar 14, 2025

iprak commented Mar 15, 2025

cdnninja commented Mar 19, 2025

jcefoli commented Mar 25, 2025

patricknelson commented Mar 25, 2025

cdnninja commented Mar 25, 2025

joostlek Mar 25, 2025

Choose a reason for hiding this comment

cdnninja Mar 28, 2025

Choose a reason for hiding this comment

cdnninja commented Feb 6, 2025 •

edited

Loading

patricknelson commented Feb 17, 2025 •

edited

Loading

cdnninja commented Feb 17, 2025 •

edited

Loading