Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RedNax67/MMM-WunderGround
https://github.com/RedNax67/MMM-WunderGround
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/RedNax67/MMM-WunderGround
- Owner: RedNax67
- Created: 2016-05-13T05:39:29.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-04-25T08:35:29.000Z (over 7 years ago)
- Last Synced: 2024-08-05T10:12:06.703Z (4 months ago)
- Language: JavaScript
- Size: 4.65 MB
- Stars: 28
- Watchers: 14
- Forks: 43
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-mmm - **MMM-WunderGround**
README
# Module: Weather Underground Forecast
This is a module for MagicMirror, modified version of the default `weatherforecast` module.
This is similar to the default `weatherforecast` module, however it has additional functionality (such as displaying the probability of precipitation for each day). It also retrieves its data from Weather Underground instead of OpenWeatherMap.
The Weather Icons used in this module are created and maintained by Erik Flowers. v1.0 artwork by Lukas Bischoff. v1.1 - 2.0 artwork by Erik Flowers www.weathericons.io
## Installing the module
Clone this repository in your `~/MagicMirror/modules/` folder `( $ cd ~MagicMirror/modules/ )`:
````javascript
git clone https://github.com/RedNax67/MMM-WunderGround.git
````
## Using the module
To use this module, add it to the modules array in the `config/config.js` file:
````javascript
modules: [
{
module: 'MMM-WunderGround',
position: 'top_right',
config: {
apikey: 'xxxxxxxxxxxxx', // private; don't share!
pws: 'pws:IGELDERL219', //culemborg
hourly: '1',
fctext: '1',
fcdaycount: "5",
fcdaystart: "0",
hourlyinterval: "3",
hourlycount: "2",
alerttime: 10000,
alerttruncatestring: "english:",
roundTmpDecs: 1,
UseCardinals: 0,
layout: "horizontal",
sysstat: 0
}
};
]
````
## Configuration options
The following properties can be configured:
Option
Description
pws
Can be any WU api location info.
US Example: NY/New_York
Example: locid:NLXX8014;loctype:1
This value is REQUIRED
apikey
The Weather Underground API key, which can be obtained by creating an OpenWeatherMap account. You need either Cumulus or Anvil plan for this module. As long as you make less than 500 queries a day, this is free.
This value is REQUIRED
units
What units to use. Specified by config.js
Possible values: config.units = Specified by config.js, default = Kelvin, metric = Celsius, imperial =Fahrenheit
Default value: config.units
coloricon
show Current Weather Icon in color
Possible values: true, false
Default value: false
fcdaycount
How many days of forecast to return. Specified by config.js
Possible values: 1 - 10
Default value: 7 (7 days)
This value is optional. By default the wunderground module will return 7 days.
fcdaystart
On which day to start the forecast. Specified by config.js
Possible values: 1 - 10
Default value: 0 (Today)
This value is optional. By default the forecast will start today.
fctext
Display human readable forecast text. Specified by config.js
Possible values: 0 - 1
Default value: 1 (Will display text)
This value is optional. By default the forecast text will be displayed.
scaletxt
Scale forecast text when over 3 lines. Specified by config.js
Possible values: 0 - 1
Default value: 1 (Will scale text)
This value is optional. By default the forecast text will be scaled when needed.
daily
Display daily forecasts. Specified by config.js
Possible values: 0 - 1
Default value: 1 (Will display daily forecasts)
This value is optional. By default the daily forecast will be displayed.
hourly
Display hourly forecasts. Specified by config.js
Possible values: 0 - 1
Default value: 1 (Will display hourly forecasts)
This value is optional. By default the hourly forecast will be displayed.
hourlycount
How many hourly forecasts. Specified by config.js
Possible values: 0 - 24
Default value: 3 (Will display 4 hourly forecasts)
This value is optional. By default the 4 hourly forecasts will be displayed.
hourlyinterval
Hours between hourly forecasts. Specified by config.js
Possible values: 1 - 24
Default value: 3 (Will display hourly forecasts with 3 hour interval)
This value is optional.
updateInterval
How often does the content needs to be fetched? (Milliseconds)
Note that Wunderground updates every 15 minutes maximum. Also free version of API only allows 500 calls per day.
Possible values: 1000 - 86400000
Default value: 900000 (15 minutes)
animationSpeed
Speed of the update animation. (Milliseconds)
Possible values:0 - 5000
Default value: 2000 (2 seconds)
lang
The language of the days.
Possible values: en, nl, ru, etc ...
Default value: uses value of config.language
fade
Fade the future events to black. (Gradient)
Possible values: true or false
Default value: true
fadePoint
Where to start fade?
Possible values: 0 (top of the list) - 1 (bottom of list)
Default value: 0.25
initialLoadDelay
The initial delay before loading. If you have multiple modules that use the same API key, you might want to delay one of the requests. (Milliseconds)
Possible values: 1000 - 5000
Default value: 0
retryDelay
The delay before retrying after a request failure. (Milliseconds)
Possible values: 1000 - 60000
Default value: 2500
alerttime
The amount of time the alert is duisplayed. (Milliseconds)
Possible values: 1000 - 60000
Default value: 10000
alerttruncatestring
Truncates the aletr text at the defined word (Milliseconds)
Possible values: any string
Default value:
roundTmpDecs
Rounds off the current temperature display
Possible values: number
Default value: 1
windunits
Which units to use for windspeed
Possible values: "mph" or "bft"
Default value: "bft"
UseCardinals
Toggles the use of winddirection arrow or cardinals
Possible values: 0 or 1
Default value: 0
layout
Chooses the layout option
Possible values: "horizontal" or "vertical"
Default value: "vertical"
iconset
Selects the style of icons to show
Possible values: "colourful", "dark", "flat_black", "flat_colourful", "flat_white", "light", "novacon", "sketchy", "VCloudsWeatherIcons", "weezle"
Default value: "VCloudsWeatherIcons"
sysstat
Toggle sysinfo display
Possible values: 0 or 1
Default value: 0
debug
Toggle debug logging
Possible values: 0 or 1
Default value: 0