mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-28 12:12:20 +00:00
Updating readme and changelog and fixing typo in method
This commit is contained in:
parent
41508931be
commit
5a421220c9
@ -24,6 +24,7 @@ _This release is scheduled to be released on 2021-04-01._
|
|||||||
- Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language
|
- Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language
|
||||||
- Converted newsfeed module to use templates.
|
- Converted newsfeed module to use templates.
|
||||||
- Update documentation and help screen about invalid config files.
|
- Update documentation and help screen about invalid config files.
|
||||||
|
- Moving weather provider specific code and configuration into each provider and making hourly part of the interface.
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
|
|
||||||
|
@ -29,16 +29,23 @@ WeatherProvider.register("yourprovider", {
|
|||||||
|
|
||||||
#### `fetchCurrentWeather()`
|
#### `fetchCurrentWeather()`
|
||||||
|
|
||||||
This method is called when the weather module tries to fetch the current weather of your provider. The implementation of this method is required.
|
This method is called when the weather module tries to fetch the current weather of your provider. The implementation of this method is required for current weather support.
|
||||||
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
|
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
|
||||||
After the response is processed, the current weather information (as a [WeatherObject](#weatherobject)) needs to be set with `this.setCurrentWeather(currentWeather);`.
|
After the response is processed, the current weather information (as a [WeatherObject](#weatherobject)) needs to be set with `this.setCurrentWeather(currentWeather);`.
|
||||||
It will then automatically refresh the module DOM with the new data.
|
It will then automatically refresh the module DOM with the new data.
|
||||||
|
|
||||||
#### `fetchWeatherForecast()`
|
#### `fetchWeatherForecast()`
|
||||||
|
|
||||||
This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required.
|
This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for forecast support.
|
||||||
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
|
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
|
||||||
After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setCurrentWeather(forecast);`.
|
After the response is processed, the weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherForecast(forecast);`.
|
||||||
|
It will then automatically refresh the module DOM with the new data.
|
||||||
|
|
||||||
|
#### `fetchWeatherHourly()`
|
||||||
|
|
||||||
|
This method is called when the weather module tries to fetch the weather of your provider. The implementation of this method is required for hourly support.
|
||||||
|
The implementation can make use of the already implemented function `this.fetchData(url, method, data);`, which is returning a promise.
|
||||||
|
After the response is processed, the hourly weather forecast information (as an array of [WeatherObject](#weatherobject)s) needs to be set with `this.setWeatherHourly(forecast);`.
|
||||||
It will then automatically refresh the module DOM with the new data.
|
It will then automatically refresh the module DOM with the new data.
|
||||||
|
|
||||||
### Weather Provider instance methods
|
### Weather Provider instance methods
|
||||||
@ -63,6 +70,10 @@ This returns a WeatherDay object for the current weather.
|
|||||||
|
|
||||||
This returns an array of WeatherDay objects for the weather forecast.
|
This returns an array of WeatherDay objects for the weather forecast.
|
||||||
|
|
||||||
|
#### `weatherHourly()`
|
||||||
|
|
||||||
|
This returns an array of WeatherDay objects for the hourly weather forecast.
|
||||||
|
|
||||||
#### `fetchedLocation()`
|
#### `fetchedLocation()`
|
||||||
|
|
||||||
This returns the name of the fetched location or an empty string.
|
This returns the name of the fetched location or an empty string.
|
||||||
@ -75,6 +86,10 @@ Set the currentWeather and notify the delegate that new information is available
|
|||||||
|
|
||||||
Set the weatherForecastArray and notify the delegate that new information is available.
|
Set the weatherForecastArray and notify the delegate that new information is available.
|
||||||
|
|
||||||
|
#### `setWeatherHourly(weatherHourlyArray)`
|
||||||
|
|
||||||
|
Set the weatherHourlyArray and notify the delegate that new information is available.
|
||||||
|
|
||||||
#### `setFetchedLocation(name)`
|
#### `setFetchedLocation(name)`
|
||||||
|
|
||||||
Set the fetched location name.
|
Set the fetched location name.
|
||||||
|
@ -97,7 +97,7 @@ var WeatherProvider = Class.extend({
|
|||||||
},
|
},
|
||||||
|
|
||||||
// Set the weatherHourlyArray and notify the delegate that new information is available.
|
// Set the weatherHourlyArray and notify the delegate that new information is available.
|
||||||
setWeatherHourlyData: function (weatherHourlyArray) {
|
setWeatherHourly: function (weatherHourlyArray) {
|
||||||
this.weatherHourlyArray = weatherHourlyArray;
|
this.weatherHourlyArray = weatherHourlyArray;
|
||||||
},
|
},
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user