Merge branch 'develop' into weather_forecast_screenshot

This commit is contained in:
Michael Teeuw 2018-10-26 14:40:57 +02:00 committed by GitHub
commit c5e3422fcd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 44 additions and 19 deletions

View File

@ -10,9 +10,15 @@ This project adheres to [Semantic Versioning](http://semver.org/).
*This release is scheduled to be released on 2018-10-01.* *This release is scheduled to be released on 2018-10-01.*
### Added ### Added
- Screenshot to the weather forecast module - Added `showEnd` documentation
- Screenshot for the new feed module
- Screenshot for the compliments module
- Screenshot for the clock module
- Screenshot for the current weather
- Screenshot for the weather forecast module
### Fixed ### Fixed
- Fixed Polish translation for Single Update Info
### Updated ### Updated

View File

@ -69,7 +69,7 @@ var config = {
header: "Weather Forecast", header: "Weather Forecast",
config: { config: {
location: "New York", location: "New York",
locationID: "5128581", //ID from http://www.openweathermap.org/help/city_list.txt locationID: "5128581", //ID from https://openweathermap.org/city
appid: "YOUR_OPENWEATHER_API_KEY" appid: "YOUR_OPENWEATHER_API_KEY"
} }
}, },

View File

@ -44,6 +44,7 @@ The following properties can be configured:
| `dateFormat` | Format to use for the date of events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th) | `dateFormat` | Format to use for the date of events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
| `fullDayEventDateFormat` | Format to use for the date of full day events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th) | `fullDayEventDateFormat` | Format to use for the date of full day events (when using absolute dates) <br><br> **Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/) <br> **Default value:** `MMM Do` (e.g. Jan 18th)
| `timeFormat` | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it <br><br> **Possible values:** `absolute` or `relative` or `dateheaders` <br> **Default value:** `relative` | `timeFormat` | Display event times as absolute dates, or relative time, or using absolute date headers with times for each event next to it <br><br> **Possible values:** `absolute` or `relative` or `dateheaders` <br> **Default value:** `relative`
| `showEnd` | Display the end of a date as well <br><br> **Possible values:** `true` or `false` <br> **Default value:** `true`
| `getRelative` | How much time (in hours) should be left until calendar events start getting relative? <br><br> **Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts) <br> **Default value:** `6` | `getRelative` | How much time (in hours) should be left until calendar events start getting relative? <br><br> **Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts) <br> **Default value:** `6`
| `urgency` | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates <br><br> **Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days) <br><br> **Default value:** `7` | `urgency` | When using a timeFormat of `absolute`, the `urgency` setting allows you to display events within a specific time frame as `relative`. This allows events within a certain time frame to be displayed as relative (in xx days) while others are displayed as absolute dates <br><br> **Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days) <br><br> **Default value:** `7`
| `broadcastEvents` | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`. <br><br> **Possible values:** `true`, `false` <br><br> **Default value:** `true` | `broadcastEvents` | If this property is set to true, the calendar will broadcast all the events to all other modules with the notification message: `CALENDAR_EVENTS`. The event objects are stored in an array and contain the following fields: `title`, `startDate`, `endDate`, `fullDayEvent`, `location` and `geo`. <br><br> **Possible values:** `true`, `false` <br><br> **Default value:** `true`

View File

@ -2,6 +2,11 @@
The `clock` module is one of the default modules of the MagicMirror. The `clock` module is one of the default modules of the MagicMirror.
This module displays the current date and time. The information will be updated realtime. This module displays the current date and time. The information will be updated realtime.
## Screenshot
- Current time
![Current time](clock_screenshot.png)
## Using the module ## Using the module
To use this module, add it to the modules array in the `config/config.js` file: To use this module, add it to the modules array in the `config/config.js` file:

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

View File

@ -2,6 +2,10 @@
The `compliments` module is one of the default modules of the MagicMirror. The `compliments` module is one of the default modules of the MagicMirror.
This module displays a random compliment. This module displays a random compliment.
## Screenshots
- Compliments Screenshot
![Compliments Screenshot](compliments_screenshot.png)
## Using the module ## Using the module
To use this module, add it to the modules array in the `config/config.js` file: To use this module, add it to the modules array in the `config/config.js` file:
@ -45,22 +49,22 @@ The `compliments` property contains an object with four arrays: <code>morning</c
If use the currentweather is possible use a actual weather for set compliments. The availables properties are: If use the currentweather is possible use a actual weather for set compliments. The availables properties are:
* `day_sunny` - `day_sunny`
* `day_cloudy` - `day_cloudy`
* `cloudy` - `cloudy`
* `cloudy_windy` - `cloudy_windy`
* `showers` - `showers`
* `rain` - `rain`
* `thunderstorm` - `thunderstorm`
* `snow` - `snow`
* `fog` - `fog`
* `night_clear` - `night_clear`
* `night_cloudy` - `night_cloudy`
* `night_showers` - `night_showers`
* `night_rain` - `night_rain`
* `night_thunderstorm` - `night_thunderstorm`
* `night_snow` - `night_snow`
* `night_alt_cloudy_windy` - `night_alt_cloudy_windy`
#### Example use with currentweather module #### Example use with currentweather module
````javascript ````javascript

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

View File

@ -2,6 +2,11 @@
The `currentweather` module is one of the default modules of the MagicMirror. The `currentweather` module is one of the default modules of the MagicMirror.
This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions. This module displays the current weather, including the windspeed, the sunset or sunrise time, the temperature and an icon to display the current conditions.
## Screenshot
- Current weather screenshot
![Current Weather Screenshot](weather_screenshot.png)
## Using the module ## Using the module
To use this module, add it to the modules array in the `config/config.js` file: To use this module, add it to the modules array in the `config/config.js` file:

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

View File

@ -2,6 +2,10 @@
The `newsfeed ` module is one of the default modules of the MagicMirror. The `newsfeed ` module is one of the default modules of the MagicMirror.
This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (````updateInterval````), but can also be controlled by sending news feed specific notifications to the module. This module displays news headlines based on an RSS feed. Scrolling through news headlines happens time-based (````updateInterval````), but can also be controlled by sending news feed specific notifications to the module.
## Screenshot
- News Feed Screenshot using the NYT
![NYT News Feed Screenshot](newsfeed_screenshot.png)
## Using the module ## Using the module
### Configuration ### Configuration

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

View File

@ -28,7 +28,7 @@
"UPDATE_NOTIFICATION": "Dostępna jest aktualizacja MagicMirror².", "UPDATE_NOTIFICATION": "Dostępna jest aktualizacja MagicMirror².",
"UPDATE_NOTIFICATION_MODULE": "Dostępna jest aktualizacja modułu {MODULE_NAME}.", "UPDATE_NOTIFICATION_MODULE": "Dostępna jest aktualizacja modułu {MODULE_NAME}.",
"UPDATE_INFO_SINGLE": "Zainstalowana wersja odbiega o {COMMIT_COUNT} commitów od gałęzi {BRANCH_NAME}.", "UPDATE_INFO_SINGLE": "Zainstalowana wersja odbiega o {COMMIT_COUNT} commit od gałęzi {BRANCH_NAME}.",
"UPDATE_INFO_MULTIPLE": "Zainstalowana wersja odbiega o {COMMIT_COUNT} commitów od gałęzi {BRANCH_NAME}.", "UPDATE_INFO_MULTIPLE": "Zainstalowana wersja odbiega o {COMMIT_COUNT} commitów od gałęzi {BRANCH_NAME}.",
"FEELS": "Odczuwalna" "FEELS": "Odczuwalna"