MMM-OpenWeatherForecastDeluxe

This a module for MagicMirror.
https://magicmirror.builders/
https://github.com/MichMich/MagicMirror

A weather module that displays current, hourly and daily forecast information using data from the OpenWeather One Call API.

Tiled Layouts	Bars Layout (daily forecast only)

Installation

NOTE: This module uses the Nunjucks templating system introduced in version 2.2.0 of MagicMirror. If you're seeing nothing on your display where you expect this module to appear, make sure your MagicMirror version is at least 2.2.0.

1. Navigate into your MagicMirror modules folder and execute
   git clone https://github.com/luxiouronimo/MMM-OpenWeatherForecastDeluxe.git.
2. Enter the new MMM-OpenWeatherForecastDeluxe directory and execute npm install.

Configuration

At a minimum you need to supply the following required configuration parameters:

• apikey
• latitude
• longitude

You can request an API key to access data here: https://openweathermap.org/api/one-call-api

Free tier is fine -- by itself, a single instance of this module will not make any where near 1000 request on one day with the default updateInterval of 10.

Find out your latitude and longitude here: https://www.latlong.net/

Sample Configuration

{
  module: "MMM-OpenWeatherForecastDeluxe",
  header: "Tiled Layouts",
  position: "top_right",
  classes: "default everyone",
  disabled: false,
  config: {
    apikey: "SUPER SECRET!!!",
    latitude: "51.506130",
    longitude: "-0.090270",
    hourlyForecastInterval: 2,
    maxDailiesToShow: 3,
    ignoreToday: true,
    showDayAsTomorrowInDailyForecast: true,
    showPrecipitationProbability: false,
    showWindDirection: false,
    showWindGust: false,
    iconset: "4c",
    useAnimatedIcons: false,
    label_high: "",
    label_low: "",
  }
},

More example configurations below in Layouts and Configs

Using Multiple Instances

Using increasingly larger requestDelay values can help prevent the API calls of multiple instances from being too close together, but ultimately each instance will make it's own api calls, which when combined with other modules that might use the same API, can threaten your rate limit.

You can use the listenerOnly option with multiple instances, so that only a primary one makes API calls, and other listenerOnly instances strictly do not, and instead receive notifications broadcasted with the api's payload whenever the primary instance gets its data. listenerOnly instances will not use/do not need the apikey, latitude, longitude, endpoint, updateInterval or requestDelay paremeters.

Optional Parameters

Units & Labels

While OpenWeather supports other units, thus far this module has focussed on imperial and metric. Be aware of the unit option above, which defaults to the units set for Magic Mirror.

If you want a space before or after the label, include it here.

Decimal Precision

Options for specifying the decimal precision for various measurements. OpenWeather's data is typically up to 2 decimal places, so the useful integer values are from 0 to 2.

Icon Sets

Layouts and Configs

{
  module: "MMM-OpenWeatherForecastDeluxe",
  header: "Table Layouts",
  position: "top_right",
  classes: "default everyone",
  disabled: false,
  config: {
    apikey: "SUPER SECRET!!!",
    latitude: "51.506130",
    longitude: "-0.090270",
    relativeColors: true,
    hourlyForecastLayout: "table",
    maxHourliesToShow: 5,
    dailyForecastLayout: "table",
    maxDailiesToShow: 5,
    ignoreToday: true,
    showPrecipitationProbability: false,
    showPrecipitationSeparator: false,
    showWindGust: false,
    iconset: "4c",
    useAnimatedIcons: false,
    label_ordinals: ['↓', '↙', '←', '↖', '↑', '↗', '→', '↘'],
    label_high: "",
    label_low: "",
  }
},

{
  module: "MMM-OpenWeatherForecastDeluxe",
  header: "Bars Layout (daily forecast only)",
  position: "top_right",
  classes: "default everyone",
  disabled: false,
  config: {
    apikey: "SUPER SECRET!!!",
    latitude: "51.506130",
    longitude: "-0.090270",
    relativeColors: true,
    showCurrentConditions: false,
    showExtraCurrentConditions: false,
    showSummary: false,
    showForecastTableColumnHeaderIcons: false,
    showHourlyForecast: false,
    dailyForecastLayout: 'bars',
    maxDailiesToShow: 8,
    showPrecipitationProbability: false,
    showPrecipitationSeparator: false,
    showPrecipitationAmount: false,
    showWindSpeed: false,
    showWindDirection: false,
    showWindGust: false,
    iconset: "4c",
    useAnimatedIcons: false,
    label_high: "",
    label_low: "",
  }
},

{
  module: "MMM-OpenWeatherForecastDeluxe",
  header: "Bars Layout (colored: false)",
  position: "top_right",
  classes: "default everyone",
  disabled: false,
  config: {
    apikey: "SUPER SECRET!!!",
    latitude: "51.506130",
    longitude: "-0.090270",
    colored: false,
    showCurrentConditions: false,
    showExtraCurrentConditions: false,
    showSummary: false,
    showForecastTableColumnHeaderIcons: false,
    showHourlyForecast: false,
    dailyForecastLayout: 'bars',
    maxDailiesToShow: 8,
    showPrecipitationProbability: false,
    showPrecipitationSeparator: false,
    showPrecipitationAmount: false,
    showWindSpeed: false,
    showWindDirection: false,
    showWindGust: false,
    iconset: "3m",
    useAnimatedIcons: false,
    label_high: "",
    label_low: "",
  }
},

{
  module: "MMM-OpenWeatherForecastDeluxe",
  header: "Tiled Layouts",
  position: "top_right",
  classes: "default everyone",
  disabled: false,
  config: {
    apikey: "SUPER SECRET!!!",
    latitude: "51.506130",
    longitude: "-0.090270",
    hourlyForecastInterval: 2,
    maxDailiesToShow: 3,
    ignoreToday: true,
    showDayAsTomorrowInDailyForecast: true,
    showPrecipitationProbability: false,
    showWindDirection: false,
    showWindGust: false,
    iconset: "4c",
    useAnimatedIcons: false,
    label_high: "",
    label_low: "",
  }
},

Styling

This module is set to be 300px wide by default. If you wish to override it, you can add the following to your custom.css file:

.MMM-OpenWeatherForecastDeluxe .module-content {
  width: 500px; /* adjust this to taste */
}

Most important elements of this module have one or more class names applied. Examine the MMM-OpenWeatherForecastDeluxe.css or inspect elements directly with your browser of choice to determine what class you would like to override.

For Module Developers

This module broadcasts a notification when it recieves a weather update. The notification is OPENWEATHER_ONE_CALL_FORECAST_DATA and the payload contains OpenWeather's JSON weather forecast object. For details on the weather object, see https://openweathermap.org/api/one-call-api.

Attributions

This module has a heritage; learn more!

Skycons - Animated icon set by Dark Sky
http://darkskyapp.github.io/skycons/
(using the fork created by Maxime Warner that allows individual details of the icons to be coloured
https://github.com/maxdow/skycons)

Climacons by Adam Whitcroft
http://adamwhitcroft.com/climacons/

Free Weather Icons by Svilen Petrov
https://www.behance.net/gallery/12410195/Free-Weather-Icons

Weather Icons by Thom
(Designed for DuckDuckGo)
https://dribbble.com/shots/1832162-Weather-Icons

Sets 4 and 5 were found on Graphberry, but I couldn't find the original artists.
https://www.graphberry.com/item/weather-icons
https://www.graphberry.com/item/weathera-weather-forecast-icons

Some of the icons were modified to better work with the module's structure and aesthetic.

Weather data provided by OpenWeather
https://openweathermap.org