Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nigel-daniels/MMM-3Day-Forecast
MagicMirror 2 module to show detailed 3 day forcast using the Wunderground API.
https://github.com/nigel-daniels/MMM-3Day-Forecast
Last synced: 23 days ago
JSON representation
MagicMirror 2 module to show detailed 3 day forcast using the Wunderground API.
- Host: GitHub
- URL: https://github.com/nigel-daniels/MMM-3Day-Forecast
- Owner: nigel-daniels
- License: mit
- Created: 2016-10-04T21:47:04.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T19:59:26.000Z (7 months ago)
- Last Synced: 2024-08-04T10:03:26.238Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 334 KB
- Stars: 36
- Watchers: 8
- Forks: 25
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-3Day-Forecast**
README
# MMM-3Day-Forecast
 OR 
This a module for the [MagicMirror](https://github.com/MichMich/MagicMirror/tree/develop). This module shows a 3 day forecast (today, tomorrow and the day after) using the Open Weather API. It displays the overall weather condition, highest temperature, likely-hood of rain, average humidity, highest windspeed and its direction forecast. Todays forecasts the conditions over the next few hours and the Tomorrow and Day After forecasts are based on the conditions around the middle of the day. This is designed to compliment the [MMM-Weather-Now](https://github.com/nigel-daniels/MMM-Weather-Now) module.
**Note:** This module used to use Open Weather but they reduced the free calls :-( As of May 2024 the module has migrated to using the [Weather API](https://www.weatherapi.com). The only thing you should need to change in the config is your `api_key` (See below).
## Installation
1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/nigel-daniels/MMM-3Day-Forecast`. A new folder `MMM-3Day-Forecast` will appear, navigate into it.
2. Execute `npm install` to install the node dependencies.
## Config
The entry in `config.js` can include the following options:
|Option|Description|
|---|---|
|`api_key`|**Required** This is the API key you need to use to request weather data from the OpenWeather site. Details on how to request an API key can be found [here](https://www.weatherapi.com/signup.aspx)
**Type:** `string`
**Default value:** `null`|
|`lat`|This is the latitude of the location you want to get the weather for.
**Type:** `number`
**Default value:** `0.0`|
|`lon`|This is the longitude of the location you want to get the weather for.
**Type:** `number`
**Default value:** `0.0`|
|`units`|This is the units you want the weather reporting in.
**Type** `string` Use `M` for metric OR `I` for imperial.
**Default value:** `M`|
|`lang`|This is the two character country code for the language you want the weather in, see all the supported codes [here](https://www.weatherapi.com/docs/).\*
**Type** `string`
**Default value** `en`|
|`horizontalView`|This switches the look to use a more compact and horizontal view.
**Type** `boolean`
**Default value** `false`|
|`interval`|How often the weather is updated.
**Type:** `integer`
**Default value:** `900000 // 15 minutes`|
\* This module itself only currently supports `da`, `en`, `fr`, `de`, `it`, `nb`, `zh-tw`, `pt` and `nl` for the text 'Day after', 'Kph' and 'Mph'. Thanks for all of the translations. If you have translations for these please send them over and I'll add your language to the set I can support :)
Here is an example of an entry in `config.js`
```
{
module: 'MMM-3Day-Forecast',
position: 'top_left',
config: {
api_key: 'xxxxxxxxxxxxxxxxxxxxxx',
lat: 37.3397352,
lon: -121.894958,
units: 'M',
lang: 'en',
interval: 900000
}
},
```
## Dependencies
Installed via `npm install`:
- [request](https://www.npmjs.com/package/request)
- [date-fns](https://www.npmjs.com/package/date-fns)
- [date-fns-tz](https://www.npmjs.com/package/date-fns-tz)
## Notes
I hope you like this module, I know it duplicates many other weather modules, however I missed my home-brew mirrors weather information so I recreated it for MM2. Feel free to submit pull requests or post issues and I'll do my best to respond.
## Thanks To...
- [Michael Teeuw](https://github.com/MichMich) for the [MagicMirror2](https://github.com/MichMich/MagicMirror/tree/develop) framework that made this module possible.
- [WeatherAPI](https://www.weatherapi.com) for the helpful guides and information they publish on their API.