[automower] Implementation of complete automower API #17545

MikeTheTux · 2024-10-12T06:43:44Z

[automower] Implementation of complete automower API

References:

[automower] Support of WorkAreas and write support of calendar-tasks #17246
https://developer.husqvarnagroup.cloud/apis/automower-connect-api?tab=openapi Release 2024-10-14
Bindings migration to use AbstractStorageBasedTypeProvider #14954
[automower] planner-next-start does not reflect the correct offset to GMT #17147

Current Status / TODOs:

Implementation of Read Channels:
1.1 DONE
Implementation of Write Channels:
2.1 DONE /mowers/{id}/actions
2.2 DONE /mowers/{id}/calendar
2.3 DONE /mowers/{id}/errors/confirm
2.4 DONE /mowers/{id}/settings
2.5 DONE /mowers/{id}/stayOutZones/{stayOutId}
2.6 DONE /mowers/{id}/workAreas/{workAreaId}
2.7 DONE /mowers/{id}/workAreas/{workAreaId}/calendar
2.8 DONE /mowers/{id}/messages
Dynamic Channels and Channel Groups
3.1 DONE
Readme
4.1 DONE
New Cut vs Search ratio channel:
5.1 DONE
openHAB actions
6.1 DONE
Better meta data (e.g. unit and state description) on channels
7.1 DONE
Fix [automower] planner-next-start does not reflect the correct offset to GMT #17147
8.1 DONE
i18n update
9.1 DONE
upgrade instructions
10.1 DONE

MikeTheTux · 2024-10-12T06:51:45Z

@lsiepel, do you have a good example how to implement dynamic Channels and Channel Groups? Esp. dynamic Channel Groups seems to be tricky.

bundles/org.openhab.binding.automower/README.md

lsiepel · 2024-10-12T19:09:29Z

@lsiepel, do you have a good example how to implement dynamic Channels and Channel Groups? Esp. dynamic Channel Groups seems to be tricky.

Interesting combination, don't have an example straight out of my head, let me check.

MikeTheTux · 2024-10-22T17:14:36Z

Except from dynamic channels and channel groups (which is an usability improvement only), I would consider the main part of the implementation is done.
I think it would be great that we bring this complex PR into the December release (which should be the winter break of the mower in the northern hemisphere). Therefore I would like to request an initial review round.

MikeTheTux · 2024-11-21T18:06:17Z

Implementation done - ready for review

MikeTheTux · 2024-12-06T20:44:41Z

In the meanwhile also dynamic channels are implemented.

The issue reported in openhab/openhab-webui#575 seems to be not fixed, when the channels are generated automatically. As workaround I'm adding dynamic Channel Labels as well. The Labels are then used to create unique channel uids:

newChannel = ChannelBuilder.create(channelUid, itemType).withType(channelTypeUID).withLabel(label).build();

@lsiepel, Is it worth creating an issue?

MikeTheTux · 2024-12-21T09:03:46Z

@lsiepel, will you find time to review this major change set as well? thanks in advance!

lsiepel · 2024-12-21T23:43:18Z

The issue reported in openhab/openhab-webui#575 seems to be not fixed, when the channels are generated automatically. As workaround I'm adding dynamic Channel Labels as well. The Labels are then used to create unique channel uids

Not sure if i understand the problem here. You should make sure the channelUID is unique, The label is just for display and while it woudl be very usefull, it is not constraint to be unique.

will you find time to review this major change set as well? thanks in advance!
Yes, i have holidays now, so might review this monday or tuesday, but if someone else has spare time, don't wait for me.

In the meantime, could you fix the conflict?

MikeTheTux · 2024-12-22T08:12:52Z

The issue reported in openhab/openhab-webui#575 seems to be not fixed, when the channels are generated automatically. As workaround I'm adding dynamic Channel Labels as well. The Labels are then used to create unique channel uids

Not sure if i understand the problem here. You should make sure the channelUID is unique, The label is just for display and while it woudl be very usefull, it is not constraint to be unique.

The channelUID is already unique due to the running index. The Label was not unique and repeating per message (channel.label was not set, channelType.label set, but the same type is used for all channels - therefore not unique)
This caused that the channel-wizard proposed Items using the same item name. As the item name is derived from the label, I added now the running index to the label as well ...

I think this is the code how the item names are proposed:
openhab-webui/blob/main/bundles/org.openhab.ui/web/src/components/thing/channel-list.vue

        let newItemName = this.newItemsPrefix || this.$oh.utils.normalizeLabel(this.thing.label)
        newItemName += '_'
        let suffix = channel.label || channelType.label || channel.id

It is using the thing.label + channel.label (if available), fallback to channelType.label, fallback to channel.id

As an improvement we could request that openHAB UI implements a duplication check at this stage.

Nevertheless the code works as expected / intended.
In the meanwhile I even think that adding the running index to the label makes sense. Otherwise we would produce 50 items using the same description and the user can differ them only via the channelID (but not the label).

This is how the current implementation using the workaround looks like:

I'm happy with that implementation in the binding. No need to change.

aMU5Ed · 2025-02-16T15:14:42Z

In December I got an email from Husqvarna that there will be changes in the APIs and the backend. Has anyone tested the binding with this new version? Old version will only be available until 28th of February 2025.

MikeTheTux · 2025-02-17T11:49:27Z

In December I got an email from Husqvarna that there will be changes in the APIs and the backend. Has anyone tested the binding with this new version? Old version will only be available until 28th of February 2025.

This change will affect Automower Connect Websocket API (new v2). The Automower Connect REST API will stay the same. This binding is using REST API only. Therefore it's not affected.

lsiepel · 2025-02-17T18:09:50Z

Could you fix the conflixct?

MikeTheTux · 2025-02-17T19:32:35Z

Could you fix the conflixct?

#18061 on main is the reason for the conflict. What is the best approach with least effort to resolve the conflict?

lsiepel · 2025-02-18T11:14:29Z

Could you fix the conflixct?

#18061 on main is the reason for the conflict. What is the best approach with least effort to resolve the conflict?

I would cascade all upstream commits: update your main from openhab main, afterwards update your feature branch from your main etc. Eventually your IDE will show you the conflict and ask for resolving it. If it's only the license header it would be easy to fix.

lsiepel

Just a minor comment. As this is an extensive PR, i would like to double check that

this is very well tested?
the update instructions can't fix everything, i think an upgrade notice is mandatory.

lsiepel · 2025-02-18T11:23:59Z

bundles/org.openhab.binding.automower/src/main/resources/OH-INF/update/update.xml

+			<!-- optional channels
+				<add-channel id="<xx>-start" groupIds="calendartasks">
+				<type>automower:calendarTasksStartType</type>
+				</add-channel>
+				<add-channel id="<xx>-duration" groupIds="calendartasks">
+				<type>automower:calendarTasksDurationType</type>
+				</add-channel>
+				<add-channel id="<xx>-monday" groupIds="calendartasks">
+				<type>automower:calendarTasksMondayType</type>
+				</add-channel>
+				<add-channel id="<xx>-tuesday" groupIds="calendartasks">
+				<type>automower:calendarTasksTuesdayType</type>
+				</add-channel>
+				<add-channel id="<xx>-wednesday" groupIds="calendartasks">
+				<type>automower:calendarTasksWednesdayType</type>
+				</add-channel>
+				<add-channel id="<xx>-thursday" groupIds="calendartasks">
+				<type>automower:calendarTasksThursdayType</type>
+				</add-channel>
+				<add-channel id="<xx>-friday" groupIds="calendartasks">
+				<type>automower:calendarTasksFridayType</type>
+				</add-channel>
+				<add-channel id="<xx>-saturday" groupIds="calendartasks">
+				<type>automower:calendarTasksSaturdayType</type>
+				</add-channel>
+				<add-channel id="<xx>-sunday" groupIds="calendartasks">
+				<type>automower:calendarTasksSundayType</type>
+				</add-channel>
+				<add-channel id="<xx>-workAreaId" groupIds="calendartasks">
+				<type>automower:calendarTasksWorkAreaIdType</type>
+				</add-channel>
+				<add-channel id="<xx>-workArea" groupIds="calendartasks">
+				<type>automower:workareaNameType</type>
+				</add-channel>
+			-->


Use er remove.

removed channels that are dynamically handled by the binding and therefore not specified in the update instruction.

Signed-off-by: Michael Weger <weger.michael@gmx.net>

…utomower-connect-api?tab=releases) Signed-off-by: Michael Weger <weger.michael@gmx.net>

Signed-off-by: Michael Weger <weger.michael@gmx.net>

set several channels to advance added update.xml Signed-off-by: Michael Weger <weger.michael@gmx.net>

Signed-off-by: Michael Weger <weger.michael@gmx.net>

added poll channels tests and smaller fixes creating all channels at once due to performance issues Signed-off-by: Michael Weger <weger.michael@gmx.net>

Signed-off-by: Michael Weger <weger.michael@gmx.net>

lsiepel · 2025-02-19T19:23:49Z

Only the failed build due to the factory not adding the timezoneprovider to the handler constructor.

updating header to 2025 for new files Signed-off-by: Michael Weger <weger.michael@gmx.net>

MikeTheTux · 2025-02-19T20:15:10Z

Only the failed build due to the factory not adding the timezoneprovider to the handler constructor.

Slowly but surely ...

lsiepel

Thanks, LGTM.
Do you need additional time to test the latest changes?

As this is a breaking change and the Thing needs to be recreated to have everything setup right, i would like to ask you to create an upgrade notice in the distro repository.

jlaur · 2025-02-19T21:19:43Z

....automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java

    }

    @Override
    public void handleCommand(ChannelUID channelUID, Command command) {
        if (RefreshType.REFRESH == command) {
            logger.debug("Refreshing channel '{}'", channelUID);
-            refreshChannels(channelUID);
+            // refreshChannels(channelUID); // causes >100 channel updates during setup


Left by mistake? Log says "Refreshing channel", so something seems not fully right now.

removed the logger as well as the commented refreshChannels call:

if (RefreshType.REFRESH == command) { // not implemented as it would causes >100 channel updates in a row during setup (performance) } else {

....automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java

...va/org/openhab/binding/automower/internal/rest/api/automowerconnect/AutomowerConnectApi.java

MikeTheTux · 2025-02-20T11:32:59Z

The initial implementation was tested quite allot and I'm also using it since then w/o issue.
Nevertheless I will work in the latest findings and then do some testing again before we move forward.

Is there a known deadline to meet for the next (5.0.0) release?
I'm quite busy within the next days an even weeks. Not sure, how fast I'm able to progress.

lsiepel · 2025-02-20T11:45:28Z

ess I will work in the latest findings and then do some testing again before we move forward.

Is there a known deadline to meet for the next (5.0.0) release? I'm quite busy within the next days an even weeks. Not sure, how fast I'm able to progress.

Deadline will be somewhere at the end of june i guess. But prefereably we add it before in a milestone to get some mileage and be sure all is stable before the mayor release. No rush, we have plenty of time.

MikeTheTux · 2025-02-20T19:59:39Z

As this is a breaking change and the Thing needs to be recreated to have everything setup right, i would like to ask you to create an upgrade notice in the distro repository.

The thing must not be re-created (remove and re-add thing). But new channels have to linked to items (if they shall be used). I will create an upgrade notice for that.

Signed-off-by: Michael Weger <weger.michael@gmx.net>

MikeTheTux · 2025-02-20T20:31:52Z

As this is a breaking change and the Thing needs to be recreated to have everything setup right, i would like to ask you to create an upgrade notice in the distro repository.

The thing must not be re-created (remove and re-add thing). But new channels have to linked to items (if they shall be used). I will create an upgrade notice for that.

done

MikeTheTux marked this pull request as draft October 12, 2024 06:44

MikeTheTux changed the title ~~[automower] Implementation of complete automower API~~ [automower] Implementation of complete automower API [WIP] Oct 12, 2024

MikeTheTux added the work in progress A PR that is not yet ready to be merged label Oct 12, 2024

MikeTheTux added the enhancement An enhancement or new feature for an existing add-on label Oct 12, 2024

lsiepel reviewed Oct 12, 2024

View reviewed changes

bundles/org.openhab.binding.automower/README.md Outdated Show resolved Hide resolved

MikeTheTux requested a review from lsiepel October 30, 2024 15:25

MikeTheTux removed the work in progress A PR that is not yet ready to be merged label Nov 9, 2024

MikeTheTux changed the title ~~[automower] Implementation of complete automower API [WIP]~~ [automower] Implementation of complete automower API Nov 9, 2024

MikeTheTux requested review from wborn and jlaur November 10, 2024 18:40

MikeTheTux marked this pull request as ready for review November 14, 2024 18:07

MikeTheTux added the (potentially) not backward compatible label Dec 21, 2024

lsiepel requested changes Feb 18, 2025

View reviewed changes

MikeTheTux requested review from cedricboon, jannegpriv, hmerk and lolodomo as code owners February 18, 2025 20:40

MikeTheTux added 11 commits February 19, 2025 19:41

README.md

3444fa8

Signed-off-by: Michael Weger <weger.michael@gmx.net>

testing, fixes

6f656d5

Signed-off-by: Michael Weger <weger.michael@gmx.net>

mvn i18n:generate-default-translations

2016fca

Signed-off-by: Michael Weger <weger.michael@gmx.net>

further improvements after testing

29b92c0

Signed-off-by: Michael Weger <weger.michael@gmx.net>

API release 2024-10-14 (https://developer.husqvarnagroup.cloud/apis/a…

646af93

…utomower-connect-api?tab=releases) Signed-off-by: Michael Weger <weger.michael@gmx.net>

ResetCuttingBladeUsageTime with QuantityType

075fc73

Signed-off-by: Michael Weger <weger.michael@gmx.net>

added error message

09b9f2a

set several channels to advance added update.xml Signed-off-by: Michael Weger <weger.michael@gmx.net>

static channels + channel groups

ce6c9b4

Signed-off-by: Michael Weger <weger.michael@gmx.net>

dynamic channels, static channel groups

e519c03

Signed-off-by: Michael Weger <weger.michael@gmx.net>

added message channels

8d6d233

added poll channels tests and smaller fixes creating all channels at once due to performance issues Signed-off-by: Michael Weger <weger.michael@gmx.net>

logging of the Automower API calls

543d922

Signed-off-by: Michael Weger <weger.michael@gmx.net>

MikeTheTux force-pushed the automower-API branch from b6853d4 to 543d922 Compare February 19, 2025 18:43

resolve conflict

04e46ef

Signed-off-by: Michael Weger <weger.michael@gmx.net>

fixing conflicts

d8b854d

updating header to 2025 for new files Signed-off-by: Michael Weger <weger.michael@gmx.net>

lsiepel approved these changes Feb 19, 2025

View reviewed changes

jlaur reviewed Feb 19, 2025

View reviewed changes

....automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java Outdated Show resolved Hide resolved

jlaur reviewed Feb 19, 2025

View reviewed changes

....automower/src/main/java/org/openhab/binding/automower/internal/things/AutomowerHandler.java Outdated Show resolved Hide resolved

jlaur reviewed Feb 19, 2025

View reviewed changes

...va/org/openhab/binding/automower/internal/rest/api/automowerconnect/AutomowerConnectApi.java Outdated Show resolved Hide resolved

jlaur reviewed Feb 19, 2025

View reviewed changes

...va/org/openhab/binding/automower/internal/rest/api/automowerconnect/AutomowerConnectApi.java Outdated Show resolved Hide resolved

implemented review findings

65a456b

Signed-off-by: Michael Weger <weger.michael@gmx.net>

MikeTheTux mentioned this pull request Feb 20, 2025

update instruction for automower binding, complete API openhab/openhab-distro#1727

Open

lsiepel merged commit 4ce97d5 into openhab:main Feb 20, 2025
2 checks passed

lsiepel added this to the 5.0 milestone Feb 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[automower] Implementation of complete automower API #17545

[automower] Implementation of complete automower API #17545

MikeTheTux commented Oct 12, 2024 •

edited

Loading

MikeTheTux commented Oct 12, 2024

lsiepel commented Oct 12, 2024

MikeTheTux commented Oct 22, 2024

MikeTheTux commented Nov 21, 2024

MikeTheTux commented Dec 6, 2024 •

edited

Loading

MikeTheTux commented Dec 21, 2024

lsiepel commented Dec 21, 2024 •

edited

Loading

MikeTheTux commented Dec 22, 2024 •

edited

Loading

aMU5Ed commented Feb 16, 2025

MikeTheTux commented Feb 17, 2025

lsiepel commented Feb 17, 2025

MikeTheTux commented Feb 17, 2025

lsiepel commented Feb 18, 2025

lsiepel left a comment

lsiepel Feb 18, 2025

MikeTheTux Feb 20, 2025

lsiepel commented Feb 19, 2025

MikeTheTux commented Feb 19, 2025

lsiepel left a comment •

edited

Loading

jlaur Feb 19, 2025

MikeTheTux Feb 20, 2025

MikeTheTux commented Feb 20, 2025

lsiepel commented Feb 20, 2025

MikeTheTux commented Feb 20, 2025

MikeTheTux commented Feb 20, 2025

[automower] Implementation of complete automower API #17545

[automower] Implementation of complete automower API #17545

Conversation

MikeTheTux commented Oct 12, 2024 • edited Loading

[automower] Implementation of complete automower API

MikeTheTux commented Oct 12, 2024

lsiepel commented Oct 12, 2024

MikeTheTux commented Oct 22, 2024

MikeTheTux commented Nov 21, 2024

MikeTheTux commented Dec 6, 2024 • edited Loading

MikeTheTux commented Dec 21, 2024

lsiepel commented Dec 21, 2024 • edited Loading

MikeTheTux commented Dec 22, 2024 • edited Loading

aMU5Ed commented Feb 16, 2025

MikeTheTux commented Feb 17, 2025

lsiepel commented Feb 17, 2025

MikeTheTux commented Feb 17, 2025

lsiepel commented Feb 18, 2025

lsiepel left a comment

Choose a reason for hiding this comment

lsiepel Feb 18, 2025

Choose a reason for hiding this comment

MikeTheTux Feb 20, 2025

Choose a reason for hiding this comment

lsiepel commented Feb 19, 2025

MikeTheTux commented Feb 19, 2025

lsiepel left a comment • edited Loading

Choose a reason for hiding this comment

jlaur Feb 19, 2025

Choose a reason for hiding this comment

MikeTheTux Feb 20, 2025

Choose a reason for hiding this comment

MikeTheTux commented Feb 20, 2025

lsiepel commented Feb 20, 2025

MikeTheTux commented Feb 20, 2025

MikeTheTux commented Feb 20, 2025

MikeTheTux commented Oct 12, 2024 •

edited

Loading

MikeTheTux commented Dec 6, 2024 •

edited

Loading

lsiepel commented Dec 21, 2024 •

edited

Loading

MikeTheTux commented Dec 22, 2024 •

edited

Loading

lsiepel left a comment •

edited

Loading