Linky : make use of DataConnect Enedis API #16355

lo92fr · 2024-02-01T18:06:22Z

Linky binding enhancement to support new DataConnect Enedis API

As view last week with Gael, this is a rewrite of the linky binding that use the official DataConnect Enedis API.
The use of this API will provide simpler authentification for the end user, as well as new functionnality like more granular data.

Description

This new binding version should offer right now the same functionnality that the old one.

This is WIP , will need on my side :

To fix compilation warning and code violation.
Do more in depth testing.
Would like to add more functionnality like :
- New channel to expose Tarification, tempo Day,
- Expose more granular data provide by this new API.
- Importing historical value to persistance to enable graphing.
- Add documentation on change between the old/new binding.

The evolution of linky binding was discuss as said with Gael in the following thread:
https://community.openhab.org/t/linky-use-the-api-not-the-http-webpage/129230

openhab-bot · 2024-02-01T18:11:29Z

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

https://community.openhab.org/t/linky-binding-enhancement-to-support-new-dataconnect-enedis-api/153601/1

clinique

This is a first high level review of this work in progress.

bundles/org.openhab.binding.linky/src/main/feature/feature.xml

clinique · 2024-02-02T09:03:58Z

...nhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAccountHandler.java

+     */
+    String formatAuthorizationUrl(String redirectUri);
+
+    String[] getAllPrmId();


Would not a List<String> or Set<String> be more convenient ?

change in next commit

clinique · 2024-02-02T09:06:17Z

...openhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAuthService.java

+    /**
+     * @param listener Adds the given handler
+     */
+    public void setLinkyAccountHandler(LinkyAccountHandler accountHandler) {


LinkyAccountHandler could be passed by @Reference in the constructor ?

this class was remove from the new version after refactoring the code !

clinique · 2024-02-02T09:06:31Z

...openhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAuthService.java

+    }
+
+    @Reference
+    protected void setHttpService(HttpService httpService) {


Same here ?

clinique · 2024-02-02T09:07:04Z

...openhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAuthServlet.java

+ * The xxx manages the authorization with the Linky Web API. The servlet implements the
+ * Authorization Code flow and saves the resulting refreshToken with the bridge.
+ *
+ * @author Gaël L'hopital - Initial contribution *


Extraneous ' *'

fix in next commit

clinique · 2024-02-02T09:32:05Z

...org.openhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/dto/Customer.java

+ */
+
+public class Customer {
+    @SerializedName("customer_id")


Adding setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES) could save you from using @SerializedName in many places. Also these classes could become records.

I've made the change.

Gael,

I finally remove the setFieldNamingPolicy, because it was conflicting with the deserialization use on the old Web API.

clinique · 2024-02-02T09:32:50Z

...nhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/dto/IntervalReading.java

+ */
+
+public class IntervalReading {
+    @SerializedName("value")


fix in next commit

clinique · 2024-02-02T09:34:06Z

...penhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/dto/TempoResponse.java

+
+import java.util.HashMap;
+
+import org.eclipse.jetty.jaas.spi.UserInfo;


remove in next commit

clinique · 2024-02-02T09:34:15Z

...penhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/dto/TempoResponse.java

+ */
+
+public class TempoResponse extends HashMap<String, String> {
+    @java.io.Serial


What's this ?

it seems to be need because i extend from HashMap

Your IDE could generate the serial

Yes but what's @java.io.Serial ?

I've remove this, it seems to work without this stuff.

clinique · 2024-02-02T09:37:37Z

bundles/org.openhab.binding.linky/src/main/resources/templates/index.html

+    </div>
+
+</body>
+</html>


Missing crlf

fix in next commit

openhab-bot · 2024-02-13T08:48:32Z

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

https://community.openhab.org/t/linky-communication-error/132889/39

clinique · 2024-03-04T15:32:46Z

Hello @lo92fr , are you still working on this ?

lolodomo · 2024-03-07T08:18:04Z

It was mentioned somewhere (community forum ?) that API limit will be reached with only few users using this API. If confirmed, this looks like a wrong approach.

PS: at the same time the current binding is now broken.

clinique · 2024-03-07T09:38:55Z

MyElectricalData seems to be alive and kicking as a replacement (they display serving ~2500 PDL). The good thing going this way is watherver provider is choosen the binding will be aligned with Enedis API, then be freed of website evolution and brackages.

lo92fr · 2024-03-07T17:46:08Z

MyElectricalData seems to be alive and kicking as a replacement (they display serving ~2500 PDL). The good thing going this way is watherver provider is choosen the binding will be aligned with Enedis API, then be freed of website evolution and brackages.

Hello all,

Sorry for my late response, but I was off home all February, with no access to my development computer.
So I make a pause on this, but I hope to have some time to work beginning on this weekend (but I also renovate my bathroom in my home, so don't know if I will have lot of time on it ...)

@clinique : I see your suggestion on pullrequest, I will address them as soon as possible.

Some comments around the api limitation to 5 call / seconds.
For me this is not really an issue for several reasons:

You need to call the api only once a day as the data is refresh only one time each day.
The plugin should cache data so it will only call the api when really need.
Other interesting things is that myelectricaldata have also some caching on their side, and so will call the Enedis API only when really need.

So it's not perfect, but if every user is not calling the API at the same exact time, it should be ok.

As someone already propose, I will also add some configuration so end user can change the endpoint from myelectricaldata to directly call Enedis API. I already put some code to handle the oauth configuration to do this. But It will need that the end user register officially to Enedis, and for this, the user will need to create a French law association. The is not a very complex process, but I think most user would not want to go this way ...

Best regards,
Laurent.

clinique · 2024-03-10T08:44:47Z

...nhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAccountHandler.java

+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * @author Gaël L'hopital - Initial contribution *


Extraneous '*'

fix in next commit

clinique · 2024-03-10T08:45:30Z

...openhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyAuthService.java

+
+/**
+ *
+ * @author Gaël L'hopital - Initial contribution *


Extraneous '*'

fix in next commit

lo92fr · 2024-03-29T10:34:27Z

Hello all,

Just to keep you inform.
The association was created yesterday, and I've made the request to Enedis to get direct access to the API today.
As soon as I get it, i will finalized the modification on the addon.

Best regards,
Laurent.

lolodomo · 2024-03-29T11:52:50Z

Ideally, we should keep an option for the users to choose between the original way with a direct connection to Enedis or the new way with a third-party.
PS: for your information, Gael just fixed the binding which is working again.

lo92fr · 2024-04-16T12:30:43Z

Hello @lolodomo,

Yes, you're right.
I will leave an option to toggle between direct Enedis connections, or through an third party gateway.

Laurent.

lo92fr · 2024-04-16T12:31:45Z

Hello all,

For information, I finalize to get a contract with Enedis last week.
So I should now be able to finalize the modification on the authentification part, and test this in the next week.

Laurent.

lolodomo · 2024-05-25T12:45:31Z

I added the tag "work in progress" as "WIP" is still in the PR title.
Let us know when this is no more "work in progress".

lo92fr · 2024-06-04T14:16:45Z

Hello All,

I have a doubt about the Enedis direct implementations.
I made the required change to support it, and it seems ok on technical side.

But the matter is that Enedis think it as a central cloud service, not one deployed localy on every openhab user web server.
So I'm finally not sure they will agreed to validate the application to go in production mode...

lo92fr · 2024-06-04T15:54:30Z

Hello Clinique,

I made a few commit this week, reviewing your comment.
And refactoring the binding a bit to support both myelectricalData and Enedis direct api call.

It seems to work ok, but still need to verify if Enedis will accept it to go in production this way, or if we need to have an intermediate platform to handle the consent / customer journey part.

Also, about TimeSeries, it seems great, but I prefer introduce this latter if it's ok for you.

If you have time, can you review the fixes so we can close the open conversations ?

Thanks,
Laurent.

lo92fr · 2024-06-05T16:38:55Z

Hello all,

for you information.
I've doned some test this morning with new openhab timeseries.
This is really a very cool new feature.

I was able to push consumption data, and also tempo day date to only one channel, with 2 year history for each.
After this, it is very simple to obtains graph like the one we can found on enedis site.

To give you a sample:

A consumption graph for one month, one value each day:

A tempo graph using the echart calendar :

Laurent.

clinique · 2024-06-18T07:55:49Z

...ab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyBindingConstants.java

+    public static final String YEAR_MINUS_1 = "yearly#lastYear";
+    public static final String YEAR_MINUS_2 = "yearly#year-2";
+
+    public static final String MAIN_IDENTITY = "main#Identity";


main#identity

fix on next commit

clinique · 2024-06-18T07:56:25Z

...ab.binding.linky/src/main/java/org/openhab/binding/linky/internal/LinkyBindingConstants.java

+     */
+    public static final String LINKY_SCOPES = Stream.of("am_application_scope", "default")
+            .collect(Collectors.joining(" "));
+    // "r:devices:*", "w:devices:*", "x:devices:*", "r:hubs:*",


Comments will have to be removed

fix on next commit

clinique · 2024-06-18T07:58:43Z

...penhab.binding.linky/src/main/java/org/openhab/binding/linky/internal/dto/TempoResponse.java

+ */
+
+public class TempoResponse extends HashMap<String, String> {
+    @java.io.Serial


Your IDE could generate the serial

lsiepel · 2024-08-07T10:57:54Z

@lo92fr @clinique what is the state of this pr?

lo92fr · 2024-08-08T20:00:34Z

@lo92fr @clinique what is the state of this pr?

Hello Isiepel,

This is still work in progress.
There is two different provider / bridge in the new binding.

The first provider MyElectricaldata is working quite well, just needing some few more test, and some code cleanup.

The second provider is direct Enedis ApiConnection. This can't be use like this because it will need everyone to register to Enedis, that would not be possible easily. Other options will be to provide an alternative gateway like MyElectricaldata. But so far, I don't investigate these options.

Possibly, if we want to integrate this in next version, the easiest way to go will be to drop the direct Enedis bridge, and only keep the MyElectricaldata data bridge. This is how it works today on the home assistant implementation.

Laurent.

lsiepel · 2024-08-12T10:40:22Z

@lo92fr @clinique what is the state of this pr?

Hello Isiepel,

This is still work in progress. There is two different provider / bridge in the new binding.

The first provider MyElectricaldata is working quite well, just needing some few more test, and some code cleanup.

The second provider is direct Enedis ApiConnection. This can't be use like this because it will need everyone to register to Enedis, that would not be possible easily. Other options will be to provide an alternative gateway like MyElectricaldata. But so far, I don't investigate these options.

Possibly, if we want to integrate this in next version, the easiest way to go will be to drop the direct Enedis bridge, and only keep the MyElectricaldata data bridge. This is how it works today on the home assistant implementation.

Laurent.

Wdyt @clinique ?

clinique · 2024-08-12T10:57:23Z

Yes, I think you should drop the Enedis part as it will more than likely not be used by anybody here.

Signed-off-by: Laurent ARNAL <[email protected]>

…es/MPS172TIB/prms Signed-off-by: Laurent ARNAL <[email protected]>

… same account Signed-off-by: Laurent ARNAL <[email protected]>

Signed-off-by: Laurent ARNAL <[email protected]>

…onment Signed-off-by: Laurent ARNAL <[email protected]>

Signed-off-by: Laurent ARNAL <[email protected]>

… current data/time Signed-off-by: Laurent ARNAL <[email protected]>

Signed-off-by: Laurent ARNAL <[email protected]>

review handling of URL for api based bridge Signed-off-by: Laurent ARNAL <[email protected]>

Signed-off-by: Laurent ARNAL <[email protected]>

…ount - add retry mechanisms to reconnect web bridge in case of errors Signed-off-by: Laurent ARNAL <[email protected]>

Signed-off-by: Laurent ARNAL <[email protected]>

add some more info to docs Signed-off-by: Laurent ARNAL <[email protected]>

lo92fr requested review from clinique and lolodomo as code owners February 1, 2024 18:06

clinique changed the title ~~Linkyv2~~ [WIP] Linkyv2 Feb 2, 2024

clinique reviewed Feb 2, 2024

View reviewed changes

clinique changed the title ~~[WIP] Linkyv2~~ [WIP] Linky : make use of DataConnect Enedis API Feb 2, 2024

clinique added the enhancement An enhancement or new feature for an existing add-on label Feb 2, 2024

clinique requested changes Mar 10, 2024

View reviewed changes

lo92fr force-pushed the linkyv2 branch from b6c3bd5 to 91e530d Compare March 29, 2024 12:09

lolodomo added the work in progress A PR that is not yet ready to be merged label May 25, 2024

lo92fr requested a review from clinique June 4, 2024 15:45

clinique reviewed Jun 18, 2024

View reviewed changes

clinique mentioned this pull request Aug 7, 2024

[linky] Full history of data returned by the requests #17070

Open

lo92fr added 11 commits December 17, 2024 12:44

div fixes

c82b9fe

Signed-off-by: Laurent ARNAL <[email protected]>

spotless::apply

a4593f8

Signed-off-by: Laurent ARNAL <[email protected]>

fix on time series for current value

f668587

Signed-off-by: Laurent ARNAL <[email protected]>

fix tempo channel update : missing groupId

2a09d0c

Signed-off-by: Laurent ARNAL <[email protected]>

review expose contract information with WebBridge

d5e3a00

Signed-off-by: Laurent ARNAL <[email protected]>

backport some change from main branch

74ed4a8

Signed-off-by: Laurent ARNAL <[email protected]>

fix url for getting prms infos : mes-prms-part/api/private/v2/personn…

479a0c7

…es/MPS172TIB/prms Signed-off-by: Laurent ARNAL <[email protected]>

fix getting PrmInfo on EnedisWebGateway in case of multiple PRM for a…

bb39f57

… same account Signed-off-by: Laurent ARNAL <[email protected]>

fix getIndentity for myElectricalData Bridge

9e0f5fe

Signed-off-by: Laurent ARNAL <[email protected]>

Refactor EnedisBridge to enable toggling between preprod / prod envir…

61e6831

…onment Signed-off-by: Laurent ARNAL <[email protected]>

div fixes for customer registration journey with myelectricaldata bridge

18265b0

Signed-off-by: Laurent ARNAL <[email protected]>

lo92fr force-pushed the linkyv2 branch from 1d559e9 to 18265b0 Compare December 17, 2024 11:47

lo92fr added 5 commits December 17, 2024 12:52

backport some missed mods during rebasing process

0ebdee8

Signed-off-by: Laurent ARNAL <[email protected]>

fix web api returning buggy value on some case, add a test for this.

3495c27

Signed-off-by: Laurent ARNAL <[email protected]>

review disconnection handling for EnedisWebBridge

b185b54

Signed-off-by: Laurent ARNAL <[email protected]>

remove updataState on timeseries as it broke graph by adding value on…

9bbc198

… current data/time Signed-off-by: Laurent ARNAL <[email protected]>

spotless:apply

d0b8f26

Signed-off-by: Laurent ARNAL <[email protected]>

lo92fr changed the title ~~[WIP] Linky : make use of DataConnect Enedis API~~ Linky : make use of DataConnect Enedis API Dec 18, 2024

lo92fr added 12 commits December 18, 2024 12:41

fix some code analysis warnings

0a61368

Signed-off-by: Laurent ARNAL <[email protected]>

fix some sat errors

e7b972d

Signed-off-by: Laurent ARNAL <[email protected]>

force new build

656fc4b

Signed-off-by: Laurent ARNAL <[email protected]>

fix missingcode in build report

d9e2f04

Signed-off-by: Laurent ARNAL <[email protected]>

new Enedis Web Site, first adaptations

776e6bc

Signed-off-by: Laurent ARNAL <[email protected]>

fix date handling on deserialization

21a738e

Signed-off-by: Laurent ARNAL <[email protected]>

fix dto for load curves

ee94028

Signed-off-by: Laurent ARNAL <[email protected]>

backport Dto change from main

bcd520a

review handling of URL for api based bridge Signed-off-by: Laurent ARNAL <[email protected]>

fix date format to handle both api and web base bridge

5d5fb38

Signed-off-by: Laurent ARNAL <[email protected]>

- remove disconnect() as it interfers with multiple linky on same acc…

ca4d2f4

…ount - add retry mechanisms to reconnect web bridge in case of errors Signed-off-by: Laurent ARNAL <[email protected]>

spotless:apply

465ac49

Signed-off-by: Laurent ARNAL <[email protected]>

fix hardcoded user Internal Id

0cc5fdc

add some more info to docs Signed-off-by: Laurent ARNAL <[email protected]>


		import java.util.HashMap;

		import org.eclipse.jetty.jaas.spi.UserInfo;

+                  </div>
+              </body>
+              </html>

Linky : make use of DataConnect Enedis API #16355

Are you sure you want to change the base?

Linky : make use of DataConnect Enedis API #16355

Conversation

lo92fr commented Feb 1, 2024

Linky binding enhancement to support new DataConnect Enedis API

Description

openhab-bot commented Feb 1, 2024

clinique left a 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

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

openhab-bot commented Feb 13, 2024

clinique commented Mar 4, 2024

lolodomo commented Mar 7, 2024

clinique commented Mar 7, 2024 • edited Loading

lo92fr commented Mar 7, 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

lo92fr commented Mar 29, 2024

lolodomo commented Mar 29, 2024

lo92fr commented Apr 16, 2024

lo92fr commented Apr 16, 2024

lolodomo commented May 25, 2024

lo92fr commented Jun 4, 2024

lo92fr commented Jun 4, 2024

lo92fr commented Jun 5, 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

lsiepel commented Aug 7, 2024

lo92fr commented Aug 8, 2024

lsiepel commented Aug 12, 2024

clinique commented Aug 12, 2024

clinique commented Mar 7, 2024 •

edited

Loading