[evcc] Adjust to evcc version 0.123.1 #16114

lucaarn · 2023-12-25T22:06:56Z

After the update to evcc version 0.123.0 the structure of the api changed:

url for limit energy and soc changed
minimum soc and a plan are not longer part of the loadpoint
-> Instead of that there is a new endpoint for the vehicles, where you can setup a plan with a plan limit soc and a plan time as well as a vehicle specific minimum soc

In order to fit the new api I fixed some issues and implemented a vehicle object. It is possible that the api focusses with coming version even more on vehicles than the loadpoints.

Fixes #16098

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.

org.openhab.binding.evcc-4.2.0-SNAPSHOT.zip

… 0.123.1 Signed-off-by: Luca Arnecke <luca@arnecke.name>

Signed-off-by: Luca Arnecke <luca@arnecke.name>

… new implementation of minSoC and plans (served by new api) Signed-off-by: Luca Arnecke <luca@arnecke.name>

Signed-off-by: Luca Arnecke <luca@arnecke.name>

florian-h05

Thank you for your PR, and thanks for updating the binding.

I’ve stopped keeping up with evcc‘s API change because I unfortunately I never started using evcc in production - blame the manufacturer of my wallbox because the announced Web API was never released.

Code looks good in general, please have a look at my comments.

....openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/api/dto/Loadpoint.java

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/thing/thing-types.xml

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/api/EvccAPI.java

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccHandler.java

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java

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

Signed-off-by: Luca Arnecke <luca@arnecke.name>

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java

florian-h05

Thanks for addressing my review!

I have a few (final) comments:

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

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccHandler.java

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java

Signed-off-by: Luca Arnecke <luca@arnecke.name>

florian-h05

We are getting close to the finish line!
At least from my review perspective, the add-on maintainers also have to take a look at this.

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/thing/thing-types.xml

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccHandler.java

Signed-off-by: Luca Arnecke <luca@arnecke.name>

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05

LGTM, thanks and congratulations to your first contribution!

IMHO this is ready to get merged.
@jlaur Can you please have a look or are you busy?

@lucaarn FYI I have just pushed a small commit to re-arrange the thing-types.xml regarding the comment I requested.

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/thing/thing-types.xml

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

MikeTheTux · 2024-01-31T16:14:47Z

There are 2 findings open. After addressing those, we should be ready to go from my perspective.
I would like to get this one done in order to move forward with #15744 as well as #15644.

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

MikeTheTux · 2024-01-31T19:29:44Z

@lucaarn, I proposed a check-in in order to fix the loadpoint-vehicleName channel:

The API parameter is called vehicleName, not vehicleTitle:

vehicleName is the former "vehicle-id", vehicleTitle is "<vehicleName>.vehicleTitle"

With this change we loose again the shared channel type between loadpoint and vehicle, but I guess this make sense in order to highlight the differences between the two channels and to align with the official API.

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

MikeTheTux · 2024-02-02T07:11:25Z

In order to automatize the upgrade efforts, upgrade instructions shall be implemented:
https://www.openhab.org/docs/developer/bindings/thing-xml.html#updating-thing-types

They will also make the removeChannel calls redundant:

removeChannel(CHANNEL_LOADPOINT_HAS_VEHICLE, channelGroup);
removeChannel("minSoC", channelGroup);
removeChannel("targetEnergy", channelGroup);
removeChannel("targetSoC", channelGroup);
removeChannel("targetTime", channelGroup);
removeChannel("targetTimeEnabled", channelGroup);

florian-h05 · 2024-02-02T07:18:29Z

For Things with statically defined channels in the thing-type.xml upgrade instructions should be provided, but the evcc binding dynamically creates the channels from the code, so no upgrade instructions are needed and they also wouldn’t work I think.

florian-h05

Thanks, just a few minor comments:

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/thing/thing-types.xml

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccHandler.java

florian-h05 · 2024-02-02T07:45:24Z

@MikeTheTux Can you please regenerate the default translations?
mvn i18n:generate-default-translations -pl :org.openhab.binding.evcc

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

MikeTheTux · 2024-02-02T18:45:00Z

@MikeTheTux Can you please regenerate the default translations? mvn i18n:generate-default-translations -pl :org.openhab.binding.evcc

done

MikeTheTux · 2024-02-02T18:46:41Z

For Things with statically defined channels in the thing-type.xml upgrade instructions should be provided, but the evcc binding dynamically creates the channels from the code, so no upgrade instructions are needed and they also wouldn’t work I think.

agree. the current implementation removing outdated channels is the way to go

MikeTheTux · 2024-02-02T18:47:14Z

I think I'm done from my end.
Who could do a final review and merge?

florian-h05 · 2024-02-02T18:49:44Z

I can do a review, but since I am only the evcc binding maintainer and no add-ons maintainer I cannot merge.
After my review, I will ping the add-on maintainers, they can then either do their own review or trust my review.

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

florian-h05

Overall LGTM, just some minor findings:

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

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java

...es/org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccHandler.java

....openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/api/dto/Loadpoint.java

...org.openhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/api/dto/Result.java

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

MikeTheTux · 2024-02-04T08:24:07Z

In the meanwhile I implemented #15744 on-top of this branch.
The impact on the channel handling is quite big.

Shall I ...

commit my changes into this PR?
1.1. Pro: single manual migration efforts for the users
1.2. Con: potential merge of this PR gets even further delayed
create a parallel PR?
wait until this PR is merged and then create a new PR?

florian-h05

LGTM, thanks!

@openhab/add-ons-maintainers Can you please review and merge this PR? I already did a full review as the evcc add-on maintainer.

florian-h05 · 2024-02-04T13:01:11Z

Please go for 3.

What really speaks against 1 is IMO that this PR is not really your PR, and it is already pretty big and want to avoid it growing bigger.

lsiepel

Besides this i18n comment, also note that some channels are removed and it depends on an external software upgrade. That makes this PR a breaking change. Please create a warning message at the openHAB distro repo to warn users when upgrading.

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/i18n/evcc_de.properties

* updated url of setTargetEnergy and setTargetSoC to match evcc version 0.123.1 * removed minSoc from Loadpoint (since evcc 0.123.0 part of vehicle) * renamed from targetEnergy to limitEnergy to match new evcc version * renamed from targetSoC to limitSoC to match new evcc version * plementation of vehicle object to match new evcc version 0.123.1 -> new implementation of minSoC and plans (served by new api) Signed-off-by: Luca Arnecke <luca@arnecke.name> Signed-off-by: Florian Hotze <florianh_dev@icloud.com> Signed-off-by: Michael Weger <weger.michael@gmx.net> Co-authored-by: Florian Hotze <florianh_dev@icloud.com> Co-authored-by: Michael Weger <weger.michael@gmx.net> Signed-off-by: Jørgen Austvik <jaustvik@acm.org>

* updated url of setTargetEnergy and setTargetSoC to match evcc version 0.123.1 * removed minSoc from Loadpoint (since evcc 0.123.0 part of vehicle) * renamed from targetEnergy to limitEnergy to match new evcc version * renamed from targetSoC to limitSoC to match new evcc version * plementation of vehicle object to match new evcc version 0.123.1 -> new implementation of minSoC and plans (served by new api) Signed-off-by: Luca Arnecke <luca@arnecke.name> Signed-off-by: Florian Hotze <florianh_dev@icloud.com> Signed-off-by: Michael Weger <weger.michael@gmx.net> Co-authored-by: Florian Hotze <florianh_dev@icloud.com> Co-authored-by: Michael Weger <weger.michael@gmx.net> (cherry picked from commit b316096)

openhab-bot · 2024-05-30T11:14:23Z

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/evcc-binding-electric-vehicle-charging-control-backport-4-1-0-4-2-0/135209/1

* updated url of setTargetEnergy and setTargetSoC to match evcc version 0.123.1 * removed minSoc from Loadpoint (since evcc 0.123.0 part of vehicle) * renamed from targetEnergy to limitEnergy to match new evcc version * renamed from targetSoC to limitSoC to match new evcc version * plementation of vehicle object to match new evcc version 0.123.1 -> new implementation of minSoC and plans (served by new api) Signed-off-by: Luca Arnecke <luca@arnecke.name> Signed-off-by: Florian Hotze <florianh_dev@icloud.com> Signed-off-by: Michael Weger <weger.michael@gmx.net> Co-authored-by: Florian Hotze <florianh_dev@icloud.com> Co-authored-by: Michael Weger <weger.michael@gmx.net>

lucaarn requested a review from florian-h05 as a code owner December 25, 2023 22:06

lucaarn added 6 commits December 26, 2023 00:03

updated url of setTargetEnergy and setTargetSoC to match evcc version…

d68f47b

… 0.123.1 Signed-off-by: Luca Arnecke <luca@arnecke.name>

removed minSoc from Loadpoint (since evcc 0.123.0 part of vehicle)

151cec0

Signed-off-by: Luca Arnecke <luca@arnecke.name>

renamed from targetEnergy to limitEnergy to match new evcc version

07696f2

Signed-off-by: Luca Arnecke <luca@arnecke.name>

renamed from targetSoC to limitSoC to match new evcc version

7d4f5a0

Signed-off-by: Luca Arnecke <luca@arnecke.name>

implementation of vehicle object to match new evcc version 0.123.1 ->…

bf332a4

… new implementation of minSoC and plans (served by new api) Signed-off-by: Luca Arnecke <luca@arnecke.name>

updated readme

bf39488

Signed-off-by: Luca Arnecke <luca@arnecke.name>

lucaarn force-pushed the evccV0.123.1 branch from 5125cce to bf39488 Compare December 25, 2023 23:04

florian-h05 requested changes Dec 27, 2023

View reviewed changes

florian-h05 changed the title ~~[EVCC] updated binding to support evcc version 0.123.1~~ [evcc] Adjust to evcc version 0.123.1 Dec 27, 2023

florian-h05 added the enhancement An enhancement or new feature for an existing add-on label Dec 27, 2023

fixed typo and resolved comments

99855b5

Signed-off-by: Luca Arnecke <luca@arnecke.name>

lucaarn requested a review from florian-h05 December 27, 2023 14:43

MikeTheTux reviewed Dec 27, 2023

View reviewed changes

...enhab.binding.evcc/src/main/java/org/openhab/binding/evcc/internal/EvccBindingConstants.java Show resolved Hide resolved

florian-h05 requested changes Dec 28, 2023

View reviewed changes

lucaarn added 2 commits December 28, 2023 23:02

resolved suggested fixes

df71b37

Signed-off-by: Luca Arnecke <luca@arnecke.name>

remove of channels used in previous version

c387a5e

Signed-off-by: Luca Arnecke <luca@arnecke.name>

florian-h05 requested changes Dec 28, 2023

View reviewed changes

lucaarn and others added 2 commits December 28, 2023 23:26

thing-types cleanup, removed redundant code

6f7c58b

Signed-off-by: Luca Arnecke <luca@arnecke.name>

Reorder comments in thing-types.xml

8162830

Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 approved these changes Dec 28, 2023

View reviewed changes

kaikreuzer requested a review from MikeTheTux January 2, 2024 16:31

This comment was marked as resolved.

Sign in to view

MikeTheTux mentioned this pull request Jan 14, 2024

State and command channel options are missing openhab/openhab-core#4039

Open

MikeTheTux reviewed Jan 14, 2024

View reviewed changes

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/thing/thing-types.xml Show resolved Hide resolved

MikeTheTux reviewed Jan 19, 2024

View reviewed changes

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

MikeTheTux added 2 commits January 31, 2024 20:20

fix loadpoint vehicleName channel

5635393

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

2023 -> 2024

199f5df

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

added new channels to README.md

fcd2ccc

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

florian-h05 requested changes Feb 2, 2024

View reviewed changes

review findings

8d403c8

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

MikeTheTux mentioned this pull request Feb 2, 2024

[evcc] Additional R/W channels for buffersoc, bufferstartsoc, residualpower (and others) #15644

Open

improved some categories

d0401c5

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

florian-h05 requested changes Feb 2, 2024

View reviewed changes

MikeTheTux added 2 commits February 2, 2024 21:39

implemented review findings

c9da7d6

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

removed unused parameter

2a0ac93

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

florian-h05 approved these changes Feb 4, 2024

View reviewed changes

lsiepel requested changes Feb 4, 2024

View reviewed changes

bundles/org.openhab.binding.evcc/src/main/resources/OH-INF/i18n/evcc_de.properties Outdated Show resolved Hide resolved

reverted changes in evcc_de.properties

ba2da7e

lsiepel approved these changes Feb 5, 2024

View reviewed changes

lsiepel merged commit b316096 into openhab:main Feb 5, 2024
3 checks passed

MikeTheTux mentioned this pull request Feb 5, 2024

Added breaking change alert for evcc openhab/openhab-distro#1634

Closed

lsiepel added this to the 4.2 milestone Feb 5, 2024

MikeTheTux mentioned this pull request Feb 18, 2024

[evcc] Add support of heating devices and three new channels #16378

Merged

MikeTheTux mentioned this pull request Apr 6, 2024

Added breaking change alert for evcc openhab/openhab-distro#1644

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[evcc] Adjust to evcc version 0.123.1 #16114

[evcc] Adjust to evcc version 0.123.1 #16114

lucaarn commented Dec 25, 2023 •

edited

Loading

florian-h05 left a comment

florian-h05 left a comment

florian-h05 left a comment

florian-h05 left a comment

This comment was marked as resolved.

MikeTheTux commented Jan 31, 2024

MikeTheTux commented Jan 31, 2024 •

edited

Loading

MikeTheTux commented Feb 2, 2024

florian-h05 commented Feb 2, 2024

florian-h05 left a comment

florian-h05 commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

florian-h05 commented Feb 2, 2024

florian-h05 left a comment

MikeTheTux commented Feb 4, 2024 •

edited

Loading

florian-h05 left a comment

florian-h05 commented Feb 4, 2024

lsiepel left a comment

openhab-bot commented May 30, 2024

[evcc] Adjust to evcc version 0.123.1 #16114

[evcc] Adjust to evcc version 0.123.1 #16114

Conversation

lucaarn commented Dec 25, 2023 • edited Loading

florian-h05 left a comment

Choose a reason for hiding this comment

florian-h05 left a comment

Choose a reason for hiding this comment

florian-h05 left a comment

Choose a reason for hiding this comment

florian-h05 left a comment

Choose a reason for hiding this comment

This comment was marked as resolved.

MikeTheTux commented Jan 31, 2024

MikeTheTux commented Jan 31, 2024 • edited Loading

MikeTheTux commented Feb 2, 2024

florian-h05 commented Feb 2, 2024

florian-h05 left a comment

Choose a reason for hiding this comment

florian-h05 commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

MikeTheTux commented Feb 2, 2024

florian-h05 commented Feb 2, 2024

florian-h05 left a comment

Choose a reason for hiding this comment

MikeTheTux commented Feb 4, 2024 • edited Loading

florian-h05 left a comment

Choose a reason for hiding this comment

florian-h05 commented Feb 4, 2024

lsiepel left a comment

Choose a reason for hiding this comment

openhab-bot commented May 30, 2024

lucaarn commented Dec 25, 2023 •

edited

Loading

MikeTheTux commented Jan 31, 2024 •

edited

Loading

MikeTheTux commented Feb 4, 2024 •

edited

Loading