Skip to content

Latest commit

 

History

History
36 lines (30 loc) · 2.27 KB

README.md

File metadata and controls

36 lines (30 loc) · 2.27 KB
Raw

Module: WB-weather

The WB-weather module was designed to complement the WallberryTheme module and displays the current weather and forecast.

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: "WallberryTheme/WB-weather",
		position: "bottom_bar",  // Highly suggested location
		config: {
			// See "Configuration options" for more information.
			darkSkyApiKey: "Your DarkSky API key",
			latitude:   47.603230,
			longitude: -122.330276
		}
	}
]

Configuration options

The following properties can be configured:

Option Type Description
darkSkyApiKey String Your DarkSky API key. Sign up for free at https://darksky.net/dev. Free accounts allow for 1,000 API calls per day.

This value is REQUIRED
latitude Number Your current latitude.

This value is REQUIRED
longitude Number Your current longitude.

This value is REQUIRED
units String What temperature units to use. Full units list available at DarkSky API docs (units parameter).

Possible values: "us"(imperial units), "si" (metric units), "auto" (selects units based on geographic location)
Default value: "auto"
roundTemp Boolean Round temperature value to nearest integer.

Possible values: true (round to integer) or false (display exact value with decimal point)
Default value: true
language String What language to use. Full language list available at DarkSky API docs (language parameter).

Possible values: en, nl, ru, etc...
Default value: uses value of config.language
daysToForecast Number How many days to forecast in weekly forecast.

Possible values: 0 - 8
Default value: 4
updateInterval Number How often to fetch new weather data. (Milliseconds)

Default value: 600000 (10 minutes)