Skip to content

Added a WeatherProvider for Open-Meteo#2964

Merged
rejas merged 7 commits intoMagicMirrorOrg:developfrom
angeldeejay:openmeteo-provider
Dec 26, 2022
Merged

Added a WeatherProvider for Open-Meteo#2964
rejas merged 7 commits intoMagicMirrorOrg:developfrom
angeldeejay:openmeteo-provider

Conversation

@angeldeejay
Copy link
Contributor

@angeldeejay angeldeejay commented Nov 3, 2022

Added Weather Provider for Open-Meteo.

I've found a completely free weather REST API (event with option of self-hosting) after having problems with API keys from all MagicMirror weather providers currently implemented (the remote services, not the providers themselves).

This API doesn't return information about reverse geocode from latitude and longitude options like others. I solved that issue using another free API.

APIs used

Considerations

  • This provider is config reliable so, be free to use the same config you can found in the official MagicMirror Weather module documentation.
  • This module config skips the apiKey parameter. It's not used at all. Only latitude and longitude are required.

Config examples:

modules: [
  {
    module: "weather",
    position: "top_right",
    header: "Weather Forecast",
    config: {
      updateInterval: <number here>, 
      weatherProvider: "openmeteo",
      type: "current",
      lat: <number here>,
      lon: <number here>,
      showHumidity: true,
      showWindDirectionAsArrow: true,
      showWindDirection: true,
      degreeLabel: true,
    }
  },
  {
    module: "weather",
    position: "top_right",
    header: "Weather Forecast",
    config: {
      updateInterval: <number here>,
      weatherProvider: "openmeteo",
      type: "daily",
      lat: <number here>,
      lon: <number here>
      colored: true,
      maxNumberOfDays: <number here>,
      showPrecipitationAmount: true,
      appendLocationNameToHeader: true
    }
  },
  {
    module: "weather",
    position: "top_right",
    header: "Weather Forecast",
    config: {
      updateInterval: <number here>,
      weatherProvider: "openmeteo",
      type: "hourly",
      lat: <number here>,
      lon: <number here>,
      maxEntries: <number here>,
      showPrecipitationAmount: true,
      degreeLabel: true,
      appendLocationNameToHeader: true
    }
  },
]

@angeldeejay
Copy link
Contributor Author

angeldeejay commented Nov 3, 2022

@rejas can you please take a look? Thanks!

rejas
rejas requested changes Nov 3, 2022
View reviewed changes
@angeldeejay angeldeejay requested a review from rejas November 3, 2022 22:58
@angeldeejay
Copy link
Contributor Author

angeldeejay commented Nov 4, 2022

@rejas Changes suggested marked as solved

@rejas
Copy link
Collaborator

rejas commented Nov 4, 2022

Trying out your PR I get an error with this config:

{
	module: "weather",
	//disabled: true,
	position: "top_right",
	config: {
		weatherProvider: 'openmeteo',
		type: "current",
		lat: 52.520008,
		lon: 13.404954,
	}
},

Error is:

Uncaught TypeError: moment.tz is undefined [openmeteo.js:218:5](http://localhost:8080/modules/default/weather/providers/openmeteo.js)

It seems it tries to guess the timezone? Is that really necessary for a current weather call?

@angeldeejay
Copy link
Contributor Author

angeldeejay commented Nov 22, 2022

I'll take a look. Thx

@angeldeejay
Copy link
Contributor Author

angeldeejay commented Dec 12, 2022 •
edited
Loading

@rejas I've removed support for moment-timezone in favor of API Documentation's param timezone with auto value supported now. Timezone is provided automatically by the OpenMeteo API using coordinates given in payload.

Please refer to Open-Meteo Weather Forecast API

rejas
rejas reviewed Dec 12, 2022
View reviewed changes
rejas
rejas requested changes Dec 12, 2022
View reviewed changes
modules/default/weather/providers/openmeteo.js
hourly: this.hourlyParams,
// Fixed units as metric
temperature_unit: "celsius",
windspeed_unit: "kmh",
Copy link
Collaborator

@rejas rejas Dec 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wind units need to be stored in meters per second in the weatherobject, not kmh. Please convert them if the api doesnt provide that

Copy link
Collaborator

@rejas rejas Dec 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isnt fixed yet

@angeldeejay
Fixed changes requested 2022-12-12:
c6e206c 
- Forecast type bug fixed. Use of type  should be working now.
- Skipping offset of start date (avoiding use of  in provider.
@angeldeejay angeldeejay requested a review from rejas December 18, 2022 07:55
@rejas
Copy link
Collaborator

rejas commented Dec 22, 2022

Since the year is rapidly nearing its end (and therefore a new release is coming up soon) I would propose to merge this even though it still has a bug (or two depending if I caught them all).
The reasoning behind it is:

  • this PR doesnt touch any other code, therefor wont break anything
  • it adds a new feature/provider which works for most use cases
  • releasing it now will get more reach for testing so more bugs can be found

Any comments @angeldeejay @khassel @sdetweil @MichMich ?

@khassel
Copy link
Collaborator

khassel commented Dec 22, 2022

@rejas feel free to merge ...

@rejas
Copy link
Collaborator

rejas commented Dec 26, 2022

Merging this in the holiday spirit :-)

@angeldeejay would be nice if you could add some documentation to the doc repo for this provider (https://github.com/MichMich/MagicMirror-Documentation) and in the new year see if you can fix the remaining bugs. Happy holidays everyone!

@rejas rejas merged commit e9be668 into MagicMirrorOrg:develop Dec 26, 2022
@angeldeejay
Copy link
Contributor Author

angeldeejay commented Jan 3, 2023

Merging this in the holiday spirit :-)

@angeldeejay would be nice if you could add some documentation to the doc repo for this provider (https://github.com/MichMich/MagicMirror-Documentation) and in the new year see if you can fix the remaining bugs. Happy holidays everyone!

I'll be adding more explained docs about this feature. Thanks for your effort

@rejas
Copy link
Collaborator

rejas commented Feb 6, 2023 •
edited
Loading

hi @angeldeejay I wanted to check in if you are still interested in updating the documentation or if you need support for that?

@rejas rejas mentioned this pull request Feb 16, 2023
Closed
@angeldeejay
Copy link
Contributor Author

angeldeejay commented Mar 1, 2023

hi @angeldeejay I wanted to check in if you are still interested in updating the documentation or if you need support for that?

Off course!, I had some personal issues the last month, but I'll be updating documentation for this provider. Sorry

@angeldeejay angeldeejay mentioned this pull request Mar 1, 2023
Merged
@angeldeejay
Copy link
Contributor Author

angeldeejay commented Mar 1, 2023

@rejas Please refer to:

rejas pushed a commit that referenced this pull request Mar 1, 2023
@angeldeejay
Fixed wind speed units for Open-Meteo Weather Provider (#3054)
23ee155 
Resolved technical debt for
[2964](#2964):

- Set wind speed unit to m/s
- Rename parameter `past_days` to `pastDays` to be consistent with all
configs
@angeldeejay angeldeejay deleted the openmeteo-provider branch March 1, 2023 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@khassel khassel khassel approved these changes

@rejas rejas Awaiting requested review from rejas

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@angeldeejay @rejas @khassel @MichMich