Add solar charging options to Wallbox integration #139286

jorisdrenth · 2025-02-25T19:54:59Z

Proposed change

Wallbox has an option in their app to charge a car using energy from a users solar panels. In the Wallbox app this can be turned off, or either one of two modes can be selected: eco mode, which starts charging at 2A and fills with energy from the net till 6A, or full solar, which starts charging at 6A energy from solar panels. A Wallbox Load balancer is needed for this functionality.

This PR adds an "Solar charging" entity to the Wallbox integration. It features a select with three options: "Off", "Eco mode" or "Full solar". This way the solar charging mode can be controlled via Home Assistant. Entity availability is checked with the Power Boost availability (Wallbox' confusing name for the load balancer).

For the API communication I also opened a PR to the Wallbox python project: cliviu74/wallbox#63. The merging of that PR is blocking for this PR.

Disclaimer: it's been 5 year since I worked with Python and this is my first PR for Home Assistant. Looking forward to receive feedback in a constructive way.

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: Update Wallbox integration docs with solar charging home-assistant.io#37700
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

Hi @jorisdrenth

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!

home-assistant · 2025-02-25T19:55:05Z

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

Code owner commands

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

jorisdrenth · 2025-02-28T18:48:45Z

PR cliviu74/wallbox#63 has been merged so I'll open this PR for review.

homeassistant/components/wallbox/manifest.json

home-assistant · 2025-02-28T23:20:46Z

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.

Stale

hesselonline · 2025-03-01T06:26:49Z

@jorisdrenth code looks fine, but please add sufficient tests for the new component.

jorisdrenth · 2025-03-01T14:26:46Z

@hesselonline I've added tests, based on the test_switch.py test and select test I've found in another component folder. It was kind of a steep learning curve so I'm not sure whether it makes any sense. Can you take a look at 1a3cd1c?

hesselonline · 2025-03-01T14:41:12Z

@hesselonline I've added tests, based on the test_switch.py test and select test I've found in another component folder. It was kind of a steep learning curve so I'm not sure whether it makes any sense. Can you take a look at 1a3cd1c?

looks good on first glance, can you check the code coverage of these tests (wallbox integration should have 100% code cov)?

jorisdrenth · 2025-03-01T14:58:17Z

@hesselonline Ah thanks for pointing that out, that's a nice feature. I've added extra tests:

---------- coverage: platform linux, python 3.13.1-final-0 -----------
Name                                              Stmts   Miss  Cover   Missing
-------------------------------------------------------------------------------
homeassistant/components/wallbox/__init__.py         25      0   100%
homeassistant/components/wallbox/config_flow.py      38      0   100%
homeassistant/components/wallbox/const.py            62      0   100%
homeassistant/components/wallbox/coordinator.py     121      4    97%   178-181
homeassistant/components/wallbox/entity.py           10      0   100%
homeassistant/components/wallbox/lock.py             32      0   100%
homeassistant/components/wallbox/number.py           49      0   100%
homeassistant/components/wallbox/select.py           31      0   100%
homeassistant/components/wallbox/sensor.py           39      0   100%
homeassistant/components/wallbox/switch.py           28      0   100%
-------------------------------------------------------------------------------
TOTAL                                               435      4    99%

The last percent are these lines. Do you have an idea how I can test them because it's just a value I set here in the test response?

hesselonline · 2025-03-01T15:04:17Z

@hesselonline Ah thanks for pointing that out, that's a nice feature. I've added extra tests:

---------- coverage: platform linux, python 3.13.1-final-0 -----------
Name                                              Stmts   Miss  Cover   Missing
-------------------------------------------------------------------------------
homeassistant/components/wallbox/__init__.py         25      0   100%
homeassistant/components/wallbox/config_flow.py      38      0   100%
homeassistant/components/wallbox/const.py            62      0   100%
homeassistant/components/wallbox/coordinator.py     121      4    97%   178-181
homeassistant/components/wallbox/entity.py           10      0   100%
homeassistant/components/wallbox/lock.py             32      0   100%
homeassistant/components/wallbox/number.py           49      0   100%
homeassistant/components/wallbox/select.py           31      0   100%
homeassistant/components/wallbox/sensor.py           39      0   100%
homeassistant/components/wallbox/switch.py           28      0   100%
-------------------------------------------------------------------------------
TOTAL                                               435      4    99%

The last percent are these lines. Do you have an idea how I can test them because it's just a value I set here in the test response?

Yes, set 3 different values in test responses

jorisdrenth · 2025-03-01T18:31:17Z

@hesselonline It has 100% code coverage now.

This reverts commit 9e2282d.

jorisdrenth · 2025-03-02T11:04:10Z

@abmantis I think this needs your review before it can be merged?

frenck · 2025-03-02T16:05:41Z

homeassistant/components/wallbox/select.py

+    async_add_entities(
+        [WallboxSelect(coordinator, SELECT_TYPES[CHARGER_ECO_SMART_KEY])]
+    )


Since SELECT_TYPES is a dict, I kinda expected the code here to iterate over it (instead of hardcode picking an item from it.

Suggested change

async_add_entities(

[WallboxSelect(coordinator, SELECT_TYPES[CHARGER_ECO_SMART_KEY])]

)

async_add_entities(

[WallboxSelect(coordinator, description)]

for description in SELECT_TYPES

)

Fixed this: 6fb9681

Your suggested code gave me an error because it only returns the key and not the value. I used the same coding style as other entities in the Wallbox component (see number.py and lock.py.

Note: in switch.py, which I used as base for the select.py file, it's also picking a value hardcoded. I'll fix that in a different PR.

frenck · 2025-03-02T16:06:12Z

homeassistant/components/wallbox/select.py

+        super().__init__(coordinator)
+        self.entity_description = description
+        self._attr_unique_id = f"{description.key}-{coordinator.data[CHARGER_DATA_KEY][CHARGER_SERIAL_NUMBER_KEY]}"
+        self._attr_icon = "mdi:solar-power"


Icons ideally go into the icons translation file (icons.json)

Check! d142208

frenck · 2025-03-02T16:06:44Z

homeassistant/components/wallbox/select.py

+        self._attr_options = [
+            EcoSmartMode.OFF,
+            EcoSmartMode.ECO_MODE,
+            EcoSmartMode.FULL_SOLAR,
+        ]


These can be set in the entity description, right?

This is fixed too: jorisdrenth@7a025df

frenck · 2025-03-02T16:07:31Z

homeassistant/components/wallbox/select.py

+            in self.coordinator.data[CHARGER_DATA_KEY][CHARGER_PLAN_KEY][
+                CHARGER_FEATURES_KEY
+            ]


Hmmm, is this is check we need to do before creating the entity? As in, this makes it sounds like this feature isn't always existing?

That's right. Solar charging is only available if a Wallbox Load Balancer is installed, which reads other energy usage in the building by (in my case) reading data from the P1 meter. Your question makes me wonder: is a "exist" option available which I should use in stead of "available"?

@jorisdrenth in the number component we do a try...except construction to check the user rights before adding the number component. Maybe you can do something similar before adding the select component. TLDR, move this check to the setup_entry, add only if the right charger features are present. (maybe combine this with the user rights check, becasue a limited Wallbox portal user will not be able to do this)

Like this? 42b68ae

frenck · 2025-03-02T16:08:27Z

homeassistant/components/wallbox/select.py

+    @property
+    def current_option(self) -> str | None:
+        """Return the current selected option."""
+        return str(self.coordinator.data[CHARGER_SOLAR_CHARGING_MODE])


Let's implement a lambda in the entity description to handle this. Right now, the entity description dict is created to be extendable, but this method isn't (it is hardcoded to a single feature).

Fixed: jorisdrenth@7a025df

frenck · 2025-03-02T16:10:05Z

tests/components/wallbox/test_select.py

+        await hass.services.async_call(
+            SELECT_DOMAIN,
+            SERVICE_SELECT_OPTION,
+            {
+                ATTR_ENTITY_ID: MOCK_SELECT_ENTITY_ID,
+                ATTR_OPTION: EcoSmartMode.FULL_SOLAR,
+            },
+            blocking=True,
+        )
+
+        await hass.services.async_call(
+            SELECT_DOMAIN,
+            SERVICE_SELECT_OPTION,
+            {
+                ATTR_ENTITY_ID: MOCK_SELECT_ENTITY_ID,
+                ATTR_OPTION: EcoSmartMode.OFF,
+            },
+            blocking=True,
+        )


Same as above.

frenck · 2025-03-02T16:10:15Z

tests/components/wallbox/test_select.py

+        await hass.services.async_call(
+            SELECT_DOMAIN,
+            SERVICE_SELECT_OPTION,
+            {
+                ATTR_ENTITY_ID: MOCK_SELECT_ENTITY_ID,
+                ATTR_OPTION: EcoSmartMode.ECO_MODE,
+            },
+            blocking=True,
+        )
+
+        await hass.services.async_call(
+            SELECT_DOMAIN,
+            SERVICE_SELECT_OPTION,
+            {
+                ATTR_ENTITY_ID: MOCK_SELECT_ENTITY_ID,
+                ATTR_OPTION: EcoSmartMode.OFF,
+            },
+            blocking=True,
+        )


Samea as above

frenck · 2025-03-02T16:10:56Z

tests/components/wallbox/test_select.py

+            status_code=404,
+        )
+
+        with pytest.raises(ConnectionError):


Errors with services should raise a ConnectionError. They should have been caught and raise an translated HomeAssistantError instead.

See jorisdrenth@09fbf86

frenck · 2025-03-02T16:11:10Z

tests/components/wallbox/test_select.py

+            status_code=403,
+        )
+
+        with pytest.raises(ConfigEntryAuthFailed):


Same as above

frenck · 2025-03-02T16:11:46Z

tests/components/wallbox/test_select.py

+        with pytest.raises(ConnectionError):
+            await hass.services.async_call(
+                SELECT_DOMAIN,
+                SERVICE_SELECT_OPTION,
+                {
+                    ATTR_ENTITY_ID: MOCK_SELECT_ENTITY_ID,
+                    ATTR_OPTION: EcoSmartMode.FULL_SOLAR,
+                },
+                blocking=True,
+            )


This is really the same thing as above, as well as the one below. This means this test can be parameterized to reduce the repetitive code.

See jorisdrenth@09fbf86

hesselonline

please move the checking for the right requirements from the 'available' property to the setup entry function.

hesselonline · 2025-03-14T12:16:27Z

homeassistant/components/wallbox/select.py

+            in self.coordinator.data[CHARGER_DATA_KEY][CHARGER_PLAN_KEY][
+                CHARGER_FEATURES_KEY
+            ]


@jorisdrenth in the number component we do a try...except construction to check the user rights before adding the number component. Maybe you can do something similar before adding the select component. TLDR, move this check to the setup_entry, add only if the right charger features are present. (maybe combine this with the user rights check, becasue a limited Wallbox portal user will not be able to do this)

jorisdrenth · 2025-03-22T21:38:05Z

@frenck @hesselonline @abmantis Can you re-review this PR? I addressed all points of feedback.

home-assistant bot previously requested changes Feb 25, 2025

View reviewed changes

home-assistant bot added cla-needed integration: wallbox new-feature new-platform Quality Scale: No score labels Feb 25, 2025

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Feb 25, 2025

This was referenced Feb 25, 2025

Wallbox solar charging home-assistant/home-assistant.io#37698

Closed

Update Wallbox integration docs with solar charging home-assistant/home-assistant.io#37700

Merged

jorisdrenth marked this pull request as ready for review February 28, 2025 18:49

abmantis requested changes Feb 28, 2025

View reviewed changes

homeassistant/components/wallbox/manifest.json Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft February 28, 2025 23:20

jorisdrenth mentioned this pull request Feb 28, 2025

Update wallbox to 0.8.0 #139553

Merged

19 tasks

jorisdrenth marked this pull request as ready for review February 28, 2025 23:59

home-assistant bot requested a review from abmantis February 28, 2025 23:59

jorisdrenth force-pushed the wallbox-solar-charging branch from 1a3cd1c to a35843a Compare March 1, 2025 14:27

Add solar charging options to Wallbox integration

ffa3d8e

jorisdrenth added 6 commits March 1, 2025 19:33

Update docstrings in Wallbox integration

a23582b

Bump wallbox requirements version

1a82778

Revert "Bump wallbox requirements version"

b777d40

This reverts commit 9e2282d.

Add Wallbox Eco Mode tests

d6ab352

Add extra tests to Wallbox select

8247a27

Add extra tests to Wallbox component

0c53ab7

jorisdrenth force-pushed the wallbox-solar-charging branch from 59e9988 to 0c53ab7 Compare March 1, 2025 18:33

Merge branch 'dev' into wallbox-solar-charging

d415ff8

frenck requested changes Mar 2, 2025

View reviewed changes

home-assistant bot marked this pull request as draft March 2, 2025 16:11

jorisdrenth added 4 commits March 2, 2025 18:35

Move entity icon to icons.json

d142208

Add WallboxSelectEntityDescription to Wallbox component

7a025df

Add iteration over dict to Wallbox select

6fb9681

Update Wallbox select tests

09fbf86

jorisdrenth requested a review from frenck March 8, 2025 23:47

Merge branch 'dev' into wallbox-solar-charging

3f4c578

jorisdrenth marked this pull request as ready for review March 8, 2025 23:50

hesselonline suggested changes Mar 14, 2025

View reviewed changes

hesselonline mentioned this pull request Mar 15, 2025

Wallbox Integration Tests mock module instead of request #140655

Open

19 tasks

jorisdrenth added 3 commits March 15, 2025 12:47

Add feature and permission at Wallbox select setup

42b68ae

Update tests of Wallbox component

5b84e4e

Merge branch 'dev' into wallbox-solar-charging

0dbd617

jorisdrenth requested a review from hesselonline March 22, 2025 21:34

hesselonline approved these changes Mar 23, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add solar charging options to Wallbox integration #139286

Add solar charging options to Wallbox integration #139286

jorisdrenth commented Feb 25, 2025 •

edited

Loading

home-assistant bot left a comment

home-assistant bot commented Feb 25, 2025

jorisdrenth commented Feb 28, 2025

home-assistant bot commented Feb 28, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

jorisdrenth commented Mar 2, 2025

frenck Mar 2, 2025

jorisdrenth Mar 6, 2025

frenck Mar 2, 2025

jorisdrenth Mar 4, 2025

frenck Mar 2, 2025

jorisdrenth Mar 4, 2025

frenck Mar 2, 2025

jorisdrenth Mar 4, 2025

hesselonline Mar 14, 2025

jorisdrenth Mar 15, 2025

frenck Mar 2, 2025

jorisdrenth Mar 4, 2025

frenck Mar 2, 2025

frenck Mar 2, 2025

frenck Mar 2, 2025

jorisdrenth Mar 8, 2025

frenck Mar 2, 2025

frenck Mar 2, 2025

jorisdrenth Mar 8, 2025

hesselonline left a comment

hesselonline Mar 14, 2025

jorisdrenth commented Mar 22, 2025

Add solar charging options to Wallbox integration #139286

Are you sure you want to change the base?

Add solar charging options to Wallbox integration #139286

Conversation

jorisdrenth commented Feb 25, 2025 • edited Loading

Proposed change

Type of change

Additional information

Checklist

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Feb 25, 2025

jorisdrenth commented Feb 28, 2025

home-assistant bot commented Feb 28, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

hesselonline commented Mar 1, 2025

jorisdrenth commented Mar 1, 2025

jorisdrenth commented Mar 2, 2025

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

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

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

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

hesselonline left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisdrenth commented Mar 22, 2025

jorisdrenth commented Feb 25, 2025 •

edited

Loading