mmm-dynamicweather
v2.15.0
Published
A heavily configurable MagicMirror Module to display different animations based on current weather and show customized event effects.
Downloads
12
Readme
Module: MMM-DynamicWeather
A heavily configurable MagicMirror Module to display different animations based on current weather and show customized event effects.
Features
- Display clouds, rain, sun, fog, lightening, and more based on real-time weather in your city
- Display custom images on specific days, such as hearts on Valentine's day
- Plenty of customization options to weather and events
Installation
In your terminal, go to your MagicMirror's Module folder:
cd ~/MagicMirror/modules
Clone this repository:
git clone https://github.com/scottcl88/MMM-DynamicWeather.git
Note: After starting the Mirror, it may take a few seconds to startup.
Using the module
To use this module, add it to the modules array in the config/config.js
file.
This module comes with many features that are heavily configurable. At it's core, it uses OpenWeatherMap's API to get your current weather data to display effects on the screen.
You will need 2 things to get started:
- A free API key from OpenWeatherMap - Sign up here
- You only need access to the Current Weather Api
- The LocationID (City ID) - follow these instructions
- Optionally you can use
lat
(latitude) andlon
(longitude) of the location you want
- Optionally you can use
This is the basic starting template, using Washington, D.C.'s location. For more examples, see Example Configurations.
{
module: "MMM-DynamicWeather",
position: "fullscreen_above",
config: { // See https://github.com/scottcl88/MMM-DynamicWeather for more information.
api_key: "your_key",
locationID: "4140963"
}
},
OR with lat
and lon
{
module: "MMM-DynamicWeather",
position: "fullscreen_above",
config: { // See https://github.com/scottcl88/MMM-DynamicWeather for more information.
api_key: "your_key",
lat: "38.89511000",
lon: "-77.03637000"
}
},
Updating
Go to the DynamicWeather module
cd ~/MagicMirror/modules/MMM-DynamicWeather
Pull latest
git pull origin master --allow-unrelated-histories
Configuration
Troubleshooting
Contributing
See Contribute Wiki
License
See LICENSE
Inspired by MichMich's Snow Plugin