[evcc] Adjust to breaking API change and add Battery Capacity channel #14245

florian-h05 · 2023-01-18T16:46:54Z

Fixes #14231.

evcc changed the API with version 0.111.0, see evcc-io/evcc#5522.
This API change breaks the binding:

all indexes become 1-based (instead of 0-based for REST and 1-based for MQTT)

SoC becomes Soc

I have also added a new channel for the home battery's capacity which is a new value available over the API.

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

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

mstormi · 2023-01-18T22:08:00Z

In the last, evcc numbered its loadpoints 0, 1, ...
Now it is 1, 2, ...

Seems this is only for writing. Reading via /api/state still exposes loadpoints[0].

Are you sure this is an intentional API change or rather an EVCC bug ? Did you ask over at their forum ?

florian-h05 · 2023-01-18T22:20:52Z

Reading though evcc-io/evcc#5522, it seems that this change was intentional. It explains as well why the SoCs aren’t working anymore.
See https://docs.evcc.io/docs/reference/api as well.

evcc changed all ids to start with 1 (loadpoints API!!), but I think we shouldn’t follow to „rename“ the channels to avoid user breaking changes.

florian-h05 · 2023-01-19T19:08:31Z

evcc-io/evcc#5649 probably brings more breaking changes.

Fixes openhab#14231. See evcc-io/evcc#5522. Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

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

florian-h05 · 2023-01-22T22:18:32Z

@jlaur Since this has been verified to fix the issue, this is ready for merging from my side!

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

jlaur · 2023-01-23T07:17:13Z

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

@@ -257,6 +258,7 @@ public void dispose() {
    private void createChannelsGeneral() {
        final String channelGroup = "general";
        if (batteryConfigured) {
+            createChannel(CHANNEL_BATTERY_CAPACITY, channelGroup, CHANNEL_TYPE_UID_BATTERY_CAPACITY, "Number:Energy");


Just a comment for future consideration: Instead of dynamically creating channels, they could be statically declared in XML and then removed when not needed. See for example #13275. The reason for doing so would be simplification.

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

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

florian-h05 · 2023-01-23T19:36:38Z

@jlaur This is ready for re-review 👍

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

jlaur

LGTM

florian-h05 · 2023-01-27T16:17:58Z

@jlaur Do you think this is something to include in a 3.4.2 Patch release (if there’s one)?

jlaur · 2023-01-27T20:11:04Z

@florian-h05 - ideally it should then have been a pure bugfix PR without introduction of a new channel. But since I understand that the binding is quite broken for all users having upgraded to evcc 0.111, I agree it's a candiate. @openhab/add-ons-maintainers, okay to cherry-pick this one?

jlaur · 2023-01-30T12:21:20Z

@lolodomo - would you agree to cherry-pick this?

KorbinianP · 2023-02-10T22:04:44Z

@jlaur @lolodomo
The binding is partly broken, you can only read values and not write any changes to the evcc instance. This would be a great candidate for the very next openhab release!

In the current 3.4.1 version the change of the mode won't do anything. I modified the state in the unreleased market place version of the binding and it works again.

jlaur · 2023-02-10T23:00:10Z

@kaikreuzer - if you agree, please cherry-pick this commit, f808edf, and 988fde1 as well (from #14381) into the 3.4.x branch before starting a build. Thanks!

* [evcc] Adjust to breaking API changes Fixes #14231. See evcc-io/evcc#5522. * [evcc] Add battery capacity channel * [evcc] Version & openHABian note * [evcc] Use already defined constants in ChannelTypeUIDs * [evcc] Correct header in evcc.properties Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

kaikreuzer · 2023-02-11T18:54:05Z

Sure @jlaur, I have cherry-picked those two fixes to 3.4.x.

* [evcc] Adjust to breaking API changes Fixes openhab#14231. See evcc-io/evcc#5522. * [evcc] Add battery capacity channel * [evcc] Version & openHABian note * [evcc] Use already defined constants in ChannelTypeUIDs * [evcc] Correct header in evcc.properties Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

florian-h05 added the bug An unexpected problem or unintended behavior of an add-on label Jan 18, 2023

florian-h05 requested a review from jlaur January 18, 2023 16:59

jlaur reviewed Jan 18, 2023

View reviewed changes

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

florian-h05 force-pushed the evcc-api-updates branch from 0edc6b0 to e79c7ef Compare January 18, 2023 23:12

florian-h05 changed the title ~~[evcc] Adjust to breaking API change~~ [evcc] Adjust to breaking API change & Add new channel Jan 18, 2023

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

florian-h05 added 4 commits January 22, 2023 14:07

[evcc] Adjust to breaking API changes

9b245ef

Fixes openhab#14231. See evcc-io/evcc#5522. Signed-off-by: Florian Hotze <florianh_dev@icloud.com>

[evcc] Add battery capacity channel

9b86ed5

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

[evcc] Version & openHABian note

acf5aef

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

[evcc] Spotless & default translations

426a8af

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

florian-h05 force-pushed the evcc-api-updates branch from e79c7ef to 426a8af Compare January 22, 2023 13:08

mj6517 mentioned this pull request Jan 22, 2023

[evcc] problems with EVCC binding after upgrade to 3.4.1 #14231

Closed

florian-h05 requested a review from jlaur January 22, 2023 22:17

jlaur removed the bug An unexpected problem or unintended behavior of an add-on label Jan 23, 2023

jlaur reviewed Jan 23, 2023

View reviewed changes

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

jlaur reviewed Jan 23, 2023

View reviewed changes

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

jlaur reviewed Jan 23, 2023

View reviewed changes

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

florian-h05 added 2 commits January 23, 2023 20:30

[evcc] Use already defined constants in ChannelTypeUIDs

c981185

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

[evcc] Revert unwanted removals from evcc.properties

8142ecd

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

florian-h05 requested a review from jlaur January 23, 2023 19:36

[evcc] Correct header in evcc.properties

cb0fca6

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

jlaur approved these changes Jan 23, 2023

View reviewed changes

jlaur merged commit f808edf into openhab:main Jan 23, 2023

jlaur added this to the 4.0 milestone Jan 23, 2023

jlaur changed the title ~~[evcc] Adjust to breaking API change & Add new channel~~ [evcc] Adjust to breaking API change and add Battery Capacity channel Jan 23, 2023

florian-h05 deleted the evcc-api-updates branch January 23, 2023 20:19

This was referenced Jan 27, 2023

[evcc] - Some state attributes are not recognized #14276

Closed

[evcc] - writes to loadpoint ID 0 while evcc expects loadpoint ID 1 #14275

Closed

florian-h05 mentioned this pull request Feb 10, 2023

[evcc] Fixes & Adjust to more breaking changes from evcc 0.111.x #14381

Merged

kaikreuzer added the patch A PR that has been cherry-picked to a patch release branch label Feb 13, 2023

lolodomo mentioned this pull request May 5, 2023

Checking if upgrade instructions were provided for all OH 4 PRs #14928

Closed

29 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[evcc] Adjust to breaking API change and add Battery Capacity channel #14245

[evcc] Adjust to breaking API change and add Battery Capacity channel #14245

florian-h05 commented Jan 18, 2023 •

edited

Loading

mstormi commented Jan 18, 2023

florian-h05 commented Jan 18, 2023 •

edited

Loading

florian-h05 commented Jan 19, 2023

florian-h05 commented Jan 22, 2023

jlaur Jan 23, 2023

florian-h05 commented Jan 23, 2023

jlaur left a comment

florian-h05 commented Jan 27, 2023

jlaur commented Jan 27, 2023

jlaur commented Jan 30, 2023

KorbinianP commented Feb 10, 2023 •

edited

Loading

jlaur commented Feb 10, 2023

kaikreuzer commented Feb 11, 2023

[evcc] Adjust to breaking API change and add Battery Capacity channel #14245

[evcc] Adjust to breaking API change and add Battery Capacity channel #14245

Conversation

florian-h05 commented Jan 18, 2023 • edited Loading

mstormi commented Jan 18, 2023

florian-h05 commented Jan 18, 2023 • edited Loading

florian-h05 commented Jan 19, 2023

florian-h05 commented Jan 22, 2023

jlaur Jan 23, 2023

Choose a reason for hiding this comment

florian-h05 commented Jan 23, 2023

jlaur left a comment

Choose a reason for hiding this comment

florian-h05 commented Jan 27, 2023

jlaur commented Jan 27, 2023

jlaur commented Jan 30, 2023

KorbinianP commented Feb 10, 2023 • edited Loading

jlaur commented Feb 10, 2023

kaikreuzer commented Feb 11, 2023

florian-h05 commented Jan 18, 2023 •

edited

Loading

florian-h05 commented Jan 18, 2023 •

edited

Loading

KorbinianP commented Feb 10, 2023 •

edited

Loading