Add husqvarna automower ble integration #108326

alistair23 · 2024-01-18T22:04:09Z

Proposed change

This PR adds support for the Husqvarna Automower BLE integration.

The Husqvarna Automower BLE integration provides connectivity with Husqvarna Automowers lawn mowers via a local Bluetooth connection. This allows connecting and controlling an Automower without any accounts, cloud or network connection.

The integration is based on AutoMower-BLE, a unofficial reverse engineered Husqvarna Automower Connect BLE library.

The integration has been tested against a 305 Automower using a ESPHome Bluetooth proxy.

This is somewhat similar to #100569, except #100569 uses the cloud API while this integration uses the local BLE. Not all mowers support BLE and not all mowers support the cloud, so although there is overlap both integrations support different mowers.

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: itegration: husqvarna_automower_ble: Initial commit home-assistant.io#30921

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

To help with the load of incoming pull requests:

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

home-assistant

There is a merge conflict.

home-assistant · 2024-02-01T22:25:06Z

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

alistair23 · 2024-02-12T09:25:23Z

@joostlek and @Thomas55555 maybe you can help get some traction on this

joostlek · 2024-02-12T09:41:23Z

Never really worked a lot with bluetooth so I can't help you on that part

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

tests/components/cast/test_media_player.py

Thomas55555 · 2024-02-12T15:38:09Z

I'm also not, and I'm self starting to learn here. I just gave you some general review.

mkmer · 2024-05-17T13:09:01Z

I made quite a few changes to a local version trying to clean up the flow and startup. It's still not perfect, and I'm not sure i like how I've set the devices up with "current" values rather than "stored" values, but I think you may find it helpful:
https://github.com/mkmer/HomeAssistant_Core/tree/ble-Husq/homeassistant/components/husqvarna_automower_ble
Pay close attention to the __init__.py execution order - there is a specific order to starting the coordinator to make sure data is available when the entities start up.

homeassistant/components/husqvarna_automower_ble/coordinator.py

homeassistant/components/husqvarna_automower_ble/__init__.py

Signed-off-by: Alistair Francis <alistair@alistair23.me>

alistair23 · 2024-05-20T11:24:33Z

Tests are passing and comments are addressed

wtaferner · 2024-05-24T03:27:07Z

Happy to see this PR and important feature to be added. Thx @alistair23 for the quite huge effort.

@emontnemery
Any chance that it might make it to the June release?

emontnemery · 2024-05-30T13:33:37Z

comments are addressed

What about this comment though: #108326 (comment), users should not have to reload the integration to make it work. What happens if the automower is out of bluetooth range?

mkmer · 2024-05-30T14:05:48Z

comments are addressed

What about this comment though: #108326 (comment), users should not have to reload the integration to make it work. What happens if the automower is out of bluetooth range?

I don't think it's possible to configure the integration if the automower is out of range (it won't / can't be discovered).
I believe we fixed the issue when it's already configured and out of range at startup, it automatically retries by raising ConfigEntryNotReady.

joostlek · 2024-06-05T09:41:39Z

tests/components/husqvarna_automower_ble/test_config_flow.py

+    assert result == snapshot
+
+    result = await hass.config_entries.flow.async_configure(
+        result["flow_id"],
+        user_input={"address": "00000000-0000-0000-0000-000000000001"},
+    )
+    assert result == snapshot


I dislike the use of snapshots here as you "hide" what you are actually testing

joostlek · 2024-06-05T09:41:50Z

tests/components/husqvarna_automower_ble/test_config_flow.py

+    await hass.async_block_till_done(wait_background_tasks=True)
+
+    result = await hass.config_entries.flow.async_init(
+        DOMAIN, context={"source": config_entries.SOURCE_USER}


Suggested change

DOMAIN, context={"source": config_entries.SOURCE_USER}

DOMAIN, context={"source": SOURCE_USER}

Personal ick

joostlek · 2024-06-05T09:42:56Z

homeassistant/components/husqvarna_automower_ble/__init__.py

+    LOGGER.debug("connected and paired")
+
+    model = await mower.get_model()
+    LOGGER.info("Connected to Automower: %s", model)


Please don't log on info level

joostlek · 2024-06-05T09:44:46Z

homeassistant/components/husqvarna_automower_ble/coordinator.py

+    def __init__(
+        self,
+        hass: HomeAssistant,
+        logger: logging.Logger,


Why are you passing in a logger if you made one on line 24?

If you like, you can also create an integration level logger with LOGGER = logging.getLogger(__package__) in const.py

joostlek · 2024-06-05T09:45:13Z

homeassistant/components/husqvarna_automower_ble/coordinator.py

+        return data
+
+
+class HusqvarnaAutomowerBleEntity(CoordinatorEntity[HusqvarnaCoordinator]):


Please move this to entity.py

joostlek · 2024-06-05T09:46:39Z

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

+        unique_id: str,
+        name: str,


Why don't we just pass in what we need and let the entity decide

joostlek · 2024-06-05T09:47:56Z

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

+    ) -> None:
+        """Initialize the lawn mower."""
+        super().__init__(coordinator)
+        self._attr_name = name


The lawn mower is the main feature of the device, so the name of the lawn mower should be set to _attr_name = None. This way, the name of this entity is decided by the name of the device, which is consistent

joostlek · 2024-06-05T09:48:53Z

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

+        [
+            AutomowerLawnMower(
+                coordinator,
+                "automower" + str(model) + "_" + str(address),


Also, for unique_id, address should be purely unique I assume? Reminder that unique_id is unique per platform per integration, so there's no need to prepend it with automower (if that's what you were trying to avoid)

joostlek · 2024-06-05T09:49:11Z

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

+        if state is None:
+            return None
+
+        if activity is None:
+            return None


can be combined

joostlek · 2024-06-05T09:49:30Z

homeassistant/components/husqvarna_automower_ble/lawn_mower.py

+                return
+
+        await self.coordinator.mower.mower_resume()
+        if self._attr_activity == LawnMowerActivity.DOCKED:


Suggested change

if self._attr_activity == LawnMowerActivity.DOCKED:

if self._attr_activity is LawnMowerActivity.DOCKED:

mkmer · 2024-06-06T18:10:32Z

homeassistant/components/husqvarna_automower_ble/config_flow.py

+        channel_id = random.randint(1, 0xFFFFFFFF)
+
+        try:
+            (manufacture, device_type, model) = await Mower(


This call appears to return a bool

File "/config/custom_components/husqvarna_automower_ble/config_flow.py", line 117, in async_step_user return await self.async_step_confirm() ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/config/custom_components/husqvarna_automower_ble/config_flow.py", line 81, in async_step_confirm (manufacture, device_type, model) = await Mower( ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ TypeError: cannot unpack non-iterable bool object

https://github.com/alistair23/AutoMower-BLE/blob/4ff003166d2b7cfaa4f9f8adacc9d1dfd9accbe7/automower_ble/protocol.py#L459

al31c0 · 2024-06-28T09:22:57Z

I have been following this integration for a long time. Is it possible to have it in the release HA 2024.7?
@elupus @emontnemery

wtaferner · 2024-06-28T09:48:35Z

@al31c0
I guess there are some pending adaptations needed by @alistair23, but he seems busy or at least nothing moved lately here. I am also looking forward to seeing this one merged, but I guess as long as you do not contribute or be able to move it forward yourself, we can just cheer, be thankful and patient for things to happen at some point 🙏🏼

home-assistant bot added cla-signed has-tests new-integration integration: husqvarna_automower_ble labels Jan 18, 2024

alistair23 mentioned this pull request Jan 18, 2024

itegration: husqvarna_automower_ble: Initial commit home-assistant/home-assistant.io#30921

Open

8 tasks

MartinHjelmare changed the title ~~husqvarna_automower_ble: Initial commit~~ Add husqvarna automower ble integration Jan 19, 2024

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 2f8f5c6 to 1a7f62f Compare January 19, 2024 21:43

alistair23 mentioned this pull request Jan 21, 2024

Thank you! alistair23/AutoMower-BLE#1

Closed

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 1a7f62f to 45de1bc Compare January 24, 2024 11:26

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 45de1bc to b6a7da4 Compare February 1, 2024 22:25

home-assistant bot previously requested changes Feb 1, 2024

View reviewed changes

home-assistant bot marked this pull request as draft February 1, 2024 22:25

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from b6a7da4 to 07c766e Compare February 1, 2024 22:38

alistair23 marked this pull request as ready for review February 1, 2024 22:45

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 07c766e to 3cd6a8e Compare February 4, 2024 22:29

alistair23 requested a review from emontnemery as a code owner February 4, 2024 22:29

Thomas55555 reviewed Feb 12, 2024

View reviewed changes

homeassistant/components/husqvarna_automower_ble/lawn_mower.py Outdated Show resolved Hide resolved

Thomas55555 reviewed Feb 12, 2024

View reviewed changes

tests/components/cast/test_media_player.py Outdated Show resolved Hide resolved

alistair23 force-pushed the alistair/husqvarna_automower_ble branch 2 times, most recently from bb611ce to 6b1c752 Compare February 13, 2024 11:34

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 6b1c752 to a54d106 Compare February 26, 2024 12:24

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from a54d106 to c3699fc Compare March 13, 2024 11:53

alistair23 force-pushed the alistair/husqvarna_automower_ble branch 3 times, most recently from 034267c to 311df40 Compare March 25, 2024 11:56

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from fe9ca25 to 5a18fe5 Compare May 17, 2024 12:42

mkmer reviewed May 17, 2024

View reviewed changes

homeassistant/components/husqvarna_automower_ble/coordinator.py Outdated Show resolved Hide resolved

mkmer reviewed May 17, 2024

View reviewed changes

homeassistant/components/husqvarna_automower_ble/__init__.py Show resolved Hide resolved

alistair23 force-pushed the alistair/husqvarna_automower_ble branch 11 times, most recently from 7b1e851 to 3ef9a6d Compare May 20, 2024 00:32

husqvarna_automower_ble: Initial commit

e2a9817

Signed-off-by: Alistair Francis <alistair@alistair23.me>

alistair23 force-pushed the alistair/husqvarna_automower_ble branch from 7c7ebf7 to e2a9817 Compare May 20, 2024 11:01

alistair23 marked this pull request as ready for review May 20, 2024 11:23

alistair23 requested a review from elupus as a code owner May 20, 2024 11:23

home-assistant bot requested review from emontnemery and mkmer May 20, 2024 11:23

joostlek requested changes Jun 5, 2024

View reviewed changes

home-assistant bot marked this pull request as draft June 5, 2024 09:49

mkmer reviewed Jun 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add husqvarna automower ble integration #108326

Add husqvarna automower ble integration #108326

alistair23 commented Jan 18, 2024 •

edited

Loading

home-assistant bot left a comment

home-assistant bot commented Feb 1, 2024

alistair23 commented Feb 12, 2024

joostlek commented Feb 12, 2024

Thomas55555 commented Feb 12, 2024

mkmer commented May 17, 2024 •

edited

Loading

alistair23 commented May 20, 2024

wtaferner commented May 24, 2024

emontnemery commented May 30, 2024

mkmer commented May 30, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

joostlek Jun 5, 2024

mkmer Jun 6, 2024 •

edited

Loading

al31c0 commented Jun 28, 2024

wtaferner commented Jun 28, 2024

	DOMAIN, context={"source": config_entries.SOURCE_USER}
	DOMAIN, context={"source": SOURCE_USER}

		return data


		class HusqvarnaAutomowerBleEntity(CoordinatorEntity[HusqvarnaCoordinator]):

	if self._attr_activity == LawnMowerActivity.DOCKED:
	if self._attr_activity is LawnMowerActivity.DOCKED:

Add husqvarna automower ble integration #108326

Are you sure you want to change the base?

Add husqvarna automower ble integration #108326

Conversation

alistair23 commented Jan 18, 2024 • 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 1, 2024

alistair23 commented Feb 12, 2024

joostlek commented Feb 12, 2024

Thomas55555 commented Feb 12, 2024

mkmer commented May 17, 2024 • edited Loading

alistair23 commented May 20, 2024

wtaferner commented May 24, 2024

emontnemery commented May 30, 2024

mkmer commented May 30, 2024

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

mkmer Jun 6, 2024 • edited Loading

Choose a reason for hiding this comment

al31c0 commented Jun 28, 2024

wtaferner commented Jun 28, 2024

alistair23 commented Jan 18, 2024 •

edited

Loading

mkmer commented May 17, 2024 •

edited

Loading

mkmer Jun 6, 2024 •

edited

Loading