[renault] Initial Contribution #11467

dougculnane · 2021-10-28T14:47:42Z

Initial renualt-api binding Issue: #11465

Electric car charging rules can be improved if the battery state of the car is known. There was a Renault ZE service API but this is no longer available and a new renault-api has a complex authentication flow. There is python implemented code that mimics the mobile app and allows a command line interface to pull data from the Renault API. (https://github.com/hacf-fr/renault-api)

It would be nice to have this available as an easy to use binding so that openHAB users can get car battery (and other) status information in openHAB.

This is a long discussion documenting the issue:
https://community.openhab.org/t/betatest-renault-ze-services-binding/72226

I have implemented a basic binding that translates the python code to a Java. It works on at least 3 cars according the the forum. https://community.openhab.org/t/betatest-renault-ze-services-binding/72226/79?u=doug_culnane

… <doug@culnane.com> Signed-off-by: Doug Culnane <doug@culnane.net>

… renault-pr

…to renault-pr

… as a result of user testing openhab#11467 Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo · 2021-11-19T13:27:20Z

I am going to review your binding.
As a first request, please add the missing entries in the openhab-addons BOM and CODEOWNERS files.

lolodomo

Review part 1 of 2

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

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

...enhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandler.java

Signed-off-by: Doug Culnane <doug@culnane.net>

dougculnane · 2021-11-19T20:04:48Z

Thanks @lolodomo for some great feedback. I think I have got all your points and I will build and test the changes locally this weekend. I hope to push a tested version ASAP.

Thanks again.

lolodomo · 2021-11-19T20:57:28Z

I will review the last part (comm part) probably tomorrow.

lolodomo

Review part 2 of 2

...nhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/renault/api/Car.java

...inding.renault/src/main/java/org/openhab/binding/renault/internal/renault/api/Constants.java

...ult/src/main/java/org/openhab/binding/renault/internal/renault/api/MyRenaultHttpSession.java

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

...enhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandler.java

...ult/src/main/java/org/openhab/binding/renault/internal/renault/api/MyRenaultHttpSession.java

dougculnane · 2021-11-21T13:07:59Z

Review part 2 of 2

Thanks @lolodomo I have a couple of questions in the comments and some work to do. I will do and test these changes and get back with an updated version.

Thanks again.

Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo

New comments after your last set of changes.

...enhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandler.java

...inding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandlerFactory.java

...ult/src/main/java/org/openhab/binding/renault/internal/renault/api/MyRenaultHttpSession.java

...nhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/renault/api/Car.java

...ult/src/main/java/org/openhab/binding/renault/internal/renault/api/MyRenaultHttpSession.java

.../main/java/org/openhab/binding/renault/internal/renault/api/exceptions/RenaultException.java

lolodomo · 2021-11-28T12:14:30Z

@dougculnane : thank you for all your changes. I marked as "resolved" most of my old comments. Please take a look to the ones which are not yet marked as resolved and please consider the new ones.
We are not too far from something clean.

Signed-off-by: Doug Culnane <doug@culnane.net>

dougculnane · 2021-11-28T19:44:58Z

@lolodomo Thanks for some good tips and feedback. I have got all currently open issues resolved or attempted to resolve them now.

Thanks again.

lolodomo

Here are my very final comments leading a clean compilation of the binding.

...enhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandler.java

...nhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/renault/api/Car.java

...enhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/RenaultHandler.java

...ult/src/main/java/org/openhab/binding/renault/internal/renault/api/MyRenaultHttpSession.java

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

dougculnane · 2021-12-03T18:58:35Z

I have refactored this to make errors more transparent. I am not sure if this is openHAB friendly? I want the thing to stay online but say there is a com error with the location (which happens in some cars). Or if you car gets un-paired I want this to be more transparent. I hope this is OK?

dougculnane · 2021-12-03T19:00:40Z

@lolodomo I hope this is OK now? Thanks again for your time.

lolodomo · 2021-12-04T10:18:19Z

I have refactored this to make errors more transparent. I am not sure if this is openHAB friendly? I want the thing to stay online but say there is a com error with the location (which happens in some cars). Or if you car gets un-paired I want this to be more transparent. I hope this is OK?

Honestly, this looks a little weird to me. Displaying a communication error but keeping the thing ONLINE.
If I correctly understand, you just want to ignore these communication errors because you already know that some of the cars will trigger these errors. Why not just keeping the thing status unchanged and add a DEBUG log that a user can display if he would like to investigate why a particular channel is not set ?
Additionally, your solution could even lead to several status changes (several communication errors) and the user will see in UI only one communication error.

dougculnane · 2021-12-04T12:28:50Z

@lolodomo I know it is not great.

The problem I am trying to solve is that if the car gets up-paired or some channels have errors there is no way of telling unless you look in the log files. The the binding need to ignore errors and keep polling so it should stay ONLINE (as far as I understand or it will stop polling). Is there a better way of reporting errors or should I create a new channel for a status message or something? Thanks again.

dougculnane · 2021-12-04T12:34:52Z

@lolodomo
There is a good suggestion at the bottom of this tread that I can do. Ignore not implemented channels:
https://community.openhab.org/t/betatest-renault-ze-services-binding/72226/115?u=doug_culnane

Is the status message a good idea or is there some other error viability idea? Or are you getting board of this?

Thanks again again.

lolodomo · 2021-12-04T13:23:29Z

For requests that are failing systematically (comm error) because not supported by a car, my opinion is that you should just log something and do nothing regarding the thing status. Avoiding next similar requests is of course a good idea. You could have "disableXXX" booleans in your car structure that you will set to true in case a first request is failing.

For requests that are failing only in not normal situations but you know that the request is applicable for the car, your current solution could be acceptable. Keep status ONLINE if you are really sure that there is not general comm problem, else set it to OFFLINE.
Note that your scheduled task will continue to be called even if your thing status is OFFLINE.

We have to conclude quickly now, even if not perfect, to have your binding part of the final 3.2 distribution.

Let me know if you want to add a new final optimization (avoid recalling for ever requests that you know they will fail).

dougculnane · 2021-12-04T13:43:50Z

@lolodomo Thanks for the advice. I will try to push an update this evening.

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

dougculnane · 2021-12-04T19:01:15Z

@lolodomo I added a not not Implemented error and disableXXX flags for the services. I keep the errors to the log files. I recreate the car Object on init so that you can reset it... Thanks again.

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

lolodomo

Very final comment

.../org.openhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/api/Car.java

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

lolodomo

LGTM

dougculnane · 2021-12-05T08:33:15Z

@lolodomo Getters and setter are done. I have tested the binding on my openHAB installation. Thanks again.

lolodomo · 2021-12-05T08:34:14Z

@dougculnane : thank you for your new binding contribution.

dougculnane · 2021-12-05T08:39:01Z

@lolodomo Merci beaucoup for your help and time getting this ready for release.

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com> Signed-off-by: Nick Waterton <n.waterton@outlook.com>

lolodomo · 2022-01-09T10:38:01Z

@dougculnane : if not yet done, you could add your binding's logo to the openHAB website. See https://www.openhab.org/docs/developer/bindings/#add-your-binding-s-logo-to-the-openhab-website

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com> Signed-off-by: Michael Schmidt <mi.schmidt.83@gmail.com>

dougculnane · 2022-01-10T19:02:34Z

@lolodomo I have created a PR for the logo here: openhab/openhab-docs#1730

All the best, Doug

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com>

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com> Signed-off-by: Andras Uhrin <andras.uhrin@gmail.com>

dougculnane requested a review from a team as a code owner October 28, 2021 14:47

openhab#11465 Initial renualt-api binding Signed-off-by: Doug Culnane…

bc4d516

… <doug@culnane.com> Signed-off-by: Doug Culnane <doug@culnane.net>

dougculnane force-pushed the renault-pr branch from 2218aab to bc4d516 Compare October 28, 2021 14:50

kaikreuzer added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Oct 28, 2021

wborn added the new binding If someone has started to work on a binding. For a new binding PR. label Oct 29, 2021

wborn linked an issue Oct 29, 2021 that may be closed by this pull request

Renault-api binding. #11465

Closed

wborn changed the title ~~#11465 Initial renualt-api binding~~ Initial renualt-api binding Oct 29, 2021

fwolter changed the title ~~Initial renualt-api binding~~ [renault] Initial Contribution Oct 29, 2021

Merge branch 'main' of https://github.com/openhab/openhab-addons into…

4167d69

… renault-pr

Flole998 added rebuild Triggers Jenkins PR build and removed rebuild Triggers Jenkins PR build labels Nov 2, 2021

dougculnane and others added 3 commits November 5, 2021 16:36

Merge branch 'openhab:main' into renault-pr

e3ce99f

Merge branch 'renault-pr' of github.com:dougculnane/openhab-addons in…

df47cb7

…to renault-pr

[renault] Initial Contribution - improved error handling for car data…

f93e644

… as a result of user testing openhab#11467 Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo requested changes Nov 19, 2021

View reviewed changes

Add the missing entries in the openhab-addons BOM and CODEOWNERS files.

fcf730e

Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo requested changes Nov 20, 2021

View reviewed changes

dougculnane added 2 commits November 27, 2021 20:54

[renault] Pull request feedback fixes.

fc4de46

Signed-off-by: Doug Culnane <doug@culnane.net>

[renault] Pull request feedback fixes added non null to the Car.

5561b7b

Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo requested changes Nov 28, 2021

View reviewed changes

dougculnane added 2 commits November 28, 2021 20:31

[renault] Pull request feedback fixes.

cda7a8d

Signed-off-by: Doug Culnane <doug@culnane.net>

[renault] Pull request feedback fixes.

b91b0c9

Signed-off-by: Doug Culnane <doug@culnane.net>

lolodomo requested changes Nov 28, 2021

View reviewed changes

[renault] More transparent Error on update.

70d765a

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

lolodomo removed the work in progress A PR that is not yet ready to be merged label Dec 4, 2021

[renault] New NotImplemented Exception and keep errors to the log.

f249eae

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

[renault] Add the new NotImplemented Exception...

adb5b95

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

lolodomo requested changes Dec 4, 2021

View reviewed changes

.../org.openhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/api/Car.java Outdated Show resolved Hide resolved

.../org.openhab.binding.renault/src/main/java/org/openhab/binding/renault/internal/api/Car.java Outdated Show resolved Hide resolved

[renault] Getters and Setters for Car.

5751dfc

Signed-off-by: Culnane Douglas <douglas.culnane@extern.a1.at>

lolodomo approved these changes Dec 5, 2021

View reviewed changes

lolodomo merged commit 3d2663c into openhab:main Dec 5, 2021

dougculnane deleted the renault-pr branch December 5, 2021 08:34

lolodomo added this to the 3.2 milestone Dec 5, 2021

nemerdaud pushed a commit to nemerdaud/openhab-addons that referenced this pull request Jan 28, 2022

[renault] Initial Contribution (openhab#11467)

b218ac2

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com>

volkmarnissen pushed a commit to volkmarnissen/openhab-addons that referenced this pull request Mar 3, 2022

[renault] Initial Contribution (openhab#11467)

a205928

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com>

marcfischerboschio pushed a commit to bosch-io/openhab-addons that referenced this pull request May 5, 2022

[renault] Initial Contribution (openhab#11467)

a0e54ea

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com>

andan67 pushed a commit to andan67/openhab-addons that referenced this pull request Nov 6, 2022

[renault] Initial Contribution (openhab#11467)

5c10de7

* openhab#11465 Initial renault-api binding Signed-off-by: Doug Culnane <doug@culnane.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[renault] Initial Contribution #11467

[renault] Initial Contribution #11467

dougculnane commented Oct 28, 2021

lolodomo commented Nov 19, 2021 •

edited

Loading

lolodomo left a comment •

edited

Loading

dougculnane commented Nov 19, 2021

lolodomo commented Nov 19, 2021

lolodomo left a comment

dougculnane commented Nov 21, 2021

lolodomo left a comment

lolodomo commented Nov 28, 2021

dougculnane commented Nov 28, 2021

lolodomo left a comment

dougculnane commented Dec 3, 2021 •

edited

Loading

dougculnane commented Dec 3, 2021

lolodomo commented Dec 4, 2021

dougculnane commented Dec 4, 2021

dougculnane commented Dec 4, 2021

lolodomo commented Dec 4, 2021

dougculnane commented Dec 4, 2021

dougculnane commented Dec 4, 2021

lolodomo left a comment

lolodomo left a comment

dougculnane commented Dec 5, 2021

lolodomo commented Dec 5, 2021

dougculnane commented Dec 5, 2021

lolodomo commented Jan 9, 2022

dougculnane commented Jan 10, 2022

[renault] Initial Contribution #11467

[renault] Initial Contribution #11467

Conversation

dougculnane commented Oct 28, 2021

lolodomo commented Nov 19, 2021 • edited Loading

lolodomo left a comment • edited Loading

Choose a reason for hiding this comment

dougculnane commented Nov 19, 2021

lolodomo commented Nov 19, 2021

lolodomo left a comment

Choose a reason for hiding this comment

dougculnane commented Nov 21, 2021

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo commented Nov 28, 2021

dougculnane commented Nov 28, 2021

lolodomo left a comment

Choose a reason for hiding this comment

dougculnane commented Dec 3, 2021 • edited Loading

dougculnane commented Dec 3, 2021

lolodomo commented Dec 4, 2021

dougculnane commented Dec 4, 2021

dougculnane commented Dec 4, 2021

lolodomo commented Dec 4, 2021

dougculnane commented Dec 4, 2021

dougculnane commented Dec 4, 2021

lolodomo left a comment

Choose a reason for hiding this comment

lolodomo left a comment

Choose a reason for hiding this comment

dougculnane commented Dec 5, 2021

lolodomo commented Dec 5, 2021

dougculnane commented Dec 5, 2021

lolodomo commented Jan 9, 2022

dougculnane commented Jan 10, 2022

lolodomo commented Nov 19, 2021 •

edited

Loading

lolodomo left a comment •

edited

Loading

dougculnane commented Dec 3, 2021 •

edited

Loading