[openweathermap] Add support for One Call API #7308 #8395

Wolfgang1966 · 2020-09-04T08:14:43Z

This PR adds support for the One Call API of Openweathermap as requested in #7308 . I tried to follow the structure of the original binding and touch it as little as possible. Especially, all existing functionality will continue to work, there are no breaking changes. The channel definitions follow the naming conventions of the original binding as far as possible, so it should be easy to adapt existing config files to the One Call API version for all channels that are supported by both APIs.

JARs for testing have already been provided and may have already been tested; I did not yet receive any feedback on it. Find them here, together with example definition files:

https://home.klimt.de/owncloud/index.php/s/BgnsYtxAAYFcZ7f

Before I started I was already in Contact with @cweitkamp , the original developer of the binding, and followed his advice on how to configure the gson mapping used by the binding.

Sign-Off has been added to all my commits.

It would be great if the PR would make it into the 2.5.9 release.

Thank you very much

Wolfgang

Signed-off-by: Kai Kreuzer <kai@openhab.org> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

TravisBuddy · 2020-09-04T08:55:38Z

Travis tests were successful

Hey @Wolfgang1966,
we found no major flaws with your code. Still you might want to look at this logfile, as we usually suggest some optional improvements.

Hilbrand · 2020-09-04T09:05:28Z

Did you see at #8253?

Wolfgang1966 · 2020-09-04T09:45:08Z

Did you see at #8253?

Yes, I also had contact with @MPH80 recently, see #7308 (comment)

His pull request changed the existing implementation and lost backward compability, as the one call API does not cover all functionality the existing binding offers. This is why I decided to add new things and leave the existing ones untouched. I also had a look at his PR to check whether I could modify it, but finally found it easier to base my changes on the original binding.

MPH80 · 2020-09-04T09:46:33Z

Did you see at #8253?

Yes, I also had contact with @MPH80 recently, see #7308 (comment)

His pull request changed the existing implementation and lost backward compability, as the one call API does not cover all functionality the existing binding offers. This is why I decided to add new things and leave the existing ones untouched. I also had a look at his PR to check whether I could modify it, but finally found it easier to base my changes on the original binding.

Indeed - I need to close my existing PR. Let me do that now.

Corrected README.md Corrected reference in thing-types.xml Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

TravisBuddy · 2020-09-04T11:22:28Z

Travis tests have failed

Hey @Wolfgang1966,
please read the following log in order to understand the failure reason. There might also be some helpful tips along the way.
It will be awesome if you fix what is wrong and commit the changes.

Hilbrand

Code looks great. Besides the inline comments, some generic:

Can you remove the first commit? There are some changes in this pr that should not be here.
Can run mvn spotless:apply to fix the codestyle of the files.
There are a lot of channel(groups). I think some of those channels and/or channel groups can get attribute advanced.
Another option could be to dynamically create the groups. Either by making it extendable to let the user create them or by let the user configure the amount of history and create that amount of groups.

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

...n/java/org/openhab/binding/openweathermap/internal/factory/OpenWeatherMapHandlerFactory.java

...org/openhab/binding/openweathermap/internal/handler/OpenWeatherMapOneCallHistoryHandler.java

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Corrected README.md Corrected reference in thing-types.xml Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 · 2020-09-27T16:06:07Z

Dear all, especially @cweitkamp and @Hilbrand

As 2.5.9 is released now, I assume it makes no sense to get this PR merged to the 2.5.x tree. So I will have to provide a PR against the main branch for a 3.0 version of this binding, correct?

I try to get the PR ready asap, but please note that ASAP at least means in a couple of days from now.

I will continue to provide snapshot builds of the 2.5.X version of this binding version at https://home.klimt.de/owncloud/index.php/s/BgnsYtxAAYFcZ7f for all who need a 2.5 version.

Should I then close this PR or is there any chance that it might still be useful?

Yours

Wolfgang

boehan · 2020-09-27T16:24:14Z

@Wolfgang1966 just a little remark: Since I just looked at your latest changes, could it be that you missed some of review comments that are hidden in the comment history (under "16 hidden conversations. Load more...")?

Wolfgang1966 · 2020-09-28T06:52:30Z

@Wolfgang1966 just a little remark: Since I just looked at your latest changes, could it be that you missed some of review comments that are hidden in the comment history (under "16 hidden conversations. Load more...")?

Oh F****, you are right! :-(

Will work on them ASAP (in the next days!). Feeling stupid now ... 👎

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 · 2020-10-04T13:16:15Z

Dear all, I worked on the comments from @cweitkamp I overlooked last time. Pushed all the changes now.

A new version of the binding is now available at
https://home.klimt.de/owncloud/index.php/s/Y7P4mWfXJs7iWNW
(the old link is no longer valid)

Next step will be to create a OH 3.0 version of the binding and a PR for that.

Wolfgang1966 · 2020-10-04T13:17:39Z

I will continue to provide snapshot builds of the 2.5.X version of this binding version at https://home.klimt.de/owncloud/index.php/s/BgnsYtxAAYFcZ7f for all who need a 2.5 version.

Use
https://home.klimt.de/owncloud/index.php/s/Y7P4mWfXJs7iWNW
instead

boehan · 2020-10-21T19:38:44Z

Did some initial testing on the One Call thing and noticed some issues with the thing configuration or dynamic channels, respectively:

set "Number of days" to 3 --> channel groups for today, tomorrow and apparent tomorrow are shown (as expected) but also for day 6 and day 7.
if I set "Number of hours" to 0 --> a channel group for hourly forecast (hour01) is still shown.
if I set "Number of minutes" to something <3 --> channel groups for Minutes01, Minutes02 and Minutes03 are still shown.

acidburn78 · 2020-10-30T20:20:02Z

Where can I find the Oh3 version?

Wolfgang1966 · 2020-10-31T11:36:51Z

Sorry, still in progress. Too many other things to do :-(

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 · 2020-11-02T17:23:47Z

Did some initial testing on the One Call thing and noticed some issues with the thing configuration or dynamic channels, respectively:

set "Number of days" to 3 --> channel groups for today, tomorrow and apparent tomorrow are shown (as expected) but also for day 6 and day 7.

if I set "Number of hours" to 0 --> a channel group for hourly forecast (hour01) is still shown.

if I set "Number of minutes" to something <3 --> channel groups for Minutes01, Minutes02 and Minutes03 are still shown.

Dear @boehan , thanks for testing! I think I found the problem and corrected it. New version of the lib is available at

https://home.klimt.de/owncloud/index.php/s/Y7P4mWfXJs7iWNW

Wolfgang1966 · 2020-11-02T17:29:44Z

As 2.5.9 obviously was NOT the final 2.x release, I concentrate now on getting the binding approved and merged before working on the OH 3 version. So may I kindly ask for reviews (especially @cweitkamp )?

Thanks a lot

Wolfgang

cweitkamp · 2020-11-02T21:02:44Z

I am afraid there will be no chance to get this into OH2.5.x anymore. Could you please re-create this PR against the main branch?
See point (4) in #8512. Thanks!

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

bundles/org.openhab.binding.openweathermap/src/main/resources/ESH-INF/thing/channel-types.xml

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 · 2020-11-18T12:39:05Z

I finally managed to create a PR for OH3: #9062

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 · 2020-11-18T12:55:04Z

Where can I find the Oh3 version?

OH3 version is now here: #9062

cweitkamp · 2020-11-22T19:30:32Z

Superseded by #9062. Closing this now.

Wolfgang1966 requested a review from cweitkamp as a code owner September 4, 2020 08:14

Wolfgang1966 mentioned this pull request Sep 4, 2020

[openweathermap] Feature request - support of the new One Call API #7308

Closed

kaikreuzer and others added 4 commits September 4, 2020 10:20

Fix missing 2.5.9-SNAPSHOT changes (#8333)

bd8b00d

Signed-off-by: Kai Kreuzer <kai@openhab.org> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Added One Call API access. Beta version, fairly tested

a820b7b

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Added One Call API access. Alpha version, not yet fully tested

c99e19f

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Small cleanups

a9c1ef0

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 requested review from davidgraeff, digitaldan, gerrieg, hmerk, kaikreuzer, marcelrv, svilenvul, wborn and a team as code owners September 4, 2020 08:32

Hilbrand added the enhancement An enhancement or new feature for an existing add-on label Sep 4, 2020

Hilbrand changed the title ~~#7308 [openweathermap] Add support for One Call API~~ [openweathermap] Add support for One Call API #7308 Sep 4, 2020

MPH80 mentioned this pull request Sep 4, 2020

[OpenWeatherMap] Convert OpenWeatherMap to use the OneCallAPI #8253

Closed

wolfii added 2 commits September 4, 2020 11:58

Added author comment to DTO classes

d9e049c

Corrected README.md Corrected reference in thing-types.xml Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Moved comment to the right place

1097b07

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Hilbrand requested changes Sep 4, 2020

View reviewed changes

wolfii added 4 commits September 5, 2020 09:50

Added One Call API access. Beta version, fairly tested

0524072

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Added One Call API access. Alpha version, not yet fully tested

b0c42e4

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Small cleanups

4c098b1

Signed-off-by: wolfii <wolfgang@klimt.de> Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Added author comment to DTO classes

aceb882

Corrected README.md Corrected reference in thing-types.xml Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Further changes requested from cweitkamp, and some fixes

956c27a

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

cweitkamp added migrate to OH3 and removed migrate to OH3 labels Oct 7, 2020

Removed null check, corrected thing add/remove logic

8b57dfb

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

cweitkamp added migrate to OH3 and removed migrate to OH3 labels Nov 2, 2020

cweitkamp removed the migrate to OH3 label Nov 2, 2020

boehan reviewed Nov 3, 2020

View reviewed changes

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

boehan reviewed Nov 3, 2020

View reviewed changes

bundles/org.openhab.binding.openweathermap/src/main/resources/ESH-INF/thing/channel-types.xml Outdated Show resolved Hide resolved

Removed nonexistent channel

dfbc877

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

Wolfgang1966 mentioned this pull request Nov 18, 2020

[openweathermap] Add support for One Call API #7308 #9062

Merged

Adapted description

0942a86

Signed-off-by: wolfii <wolfgang.klimt@consol.de>

cweitkamp closed this Nov 22, 2020

Wolfgang1966 deleted the 2.5.x branch May 2, 2022 14:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[openweathermap] Add support for One Call API #7308 #8395

[openweathermap] Add support for One Call API #7308 #8395

Wolfgang1966 commented Sep 4, 2020

TravisBuddy commented Sep 4, 2020

Hilbrand commented Sep 4, 2020

Wolfgang1966 commented Sep 4, 2020

MPH80 commented Sep 4, 2020

TravisBuddy commented Sep 4, 2020

Hilbrand left a comment

Wolfgang1966 commented Sep 27, 2020

boehan commented Sep 27, 2020

Wolfgang1966 commented Sep 28, 2020

Wolfgang1966 commented Oct 4, 2020

Wolfgang1966 commented Oct 4, 2020

boehan commented Oct 21, 2020

acidburn78 commented Oct 30, 2020

Wolfgang1966 commented Oct 31, 2020

Wolfgang1966 commented Nov 2, 2020

Wolfgang1966 commented Nov 2, 2020

cweitkamp commented Nov 2, 2020

Wolfgang1966 commented Nov 18, 2020

Wolfgang1966 commented Nov 18, 2020

cweitkamp commented Nov 22, 2020

[openweathermap] Add support for One Call API #7308 #8395

[openweathermap] Add support for One Call API #7308 #8395

Conversation

Wolfgang1966 commented Sep 4, 2020

TravisBuddy commented Sep 4, 2020

Travis tests were successful

Hilbrand commented Sep 4, 2020

Wolfgang1966 commented Sep 4, 2020

MPH80 commented Sep 4, 2020

TravisBuddy commented Sep 4, 2020

Travis tests have failed

Hilbrand left a comment

Choose a reason for hiding this comment

Wolfgang1966 commented Sep 27, 2020

boehan commented Sep 27, 2020

Wolfgang1966 commented Sep 28, 2020

Wolfgang1966 commented Oct 4, 2020

Wolfgang1966 commented Oct 4, 2020

boehan commented Oct 21, 2020

acidburn78 commented Oct 30, 2020

Wolfgang1966 commented Oct 31, 2020

Wolfgang1966 commented Nov 2, 2020

Wolfgang1966 commented Nov 2, 2020

cweitkamp commented Nov 2, 2020

Wolfgang1966 commented Nov 18, 2020

Wolfgang1966 commented Nov 18, 2020

cweitkamp commented Nov 22, 2020