From 2913120ff7ced418eb0dbe339efe7a3dfe86824e Mon Sep 17 00:00:00 2001 From: Brian Date: Tue, 17 Jan 2017 16:12:03 +0100 Subject: [PATCH 1/2] Update README files --- modules/default/alert/README.md | 141 ++--------- modules/default/calendar/README.md | 211 +++-------------- modules/default/clock/README.md | 118 ++-------- modules/default/compliments/README.md | 80 ++----- modules/default/currentweather/README.md | 235 ++++--------------- modules/default/helloworld/README.md | 23 +- modules/default/newsfeed/README.md | 200 +++------------- modules/default/updatenotification/README.md | 21 +- modules/default/weatherforecast/README.md | 212 ++++------------- 9 files changed, 211 insertions(+), 1030 deletions(-) diff --git a/modules/default/alert/README.md b/modules/default/alert/README.md index d566313dc7..89505d1642 100644 --- a/modules/default/alert/README.md +++ b/modules/default/alert/README.md @@ -21,52 +21,13 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
effectThe animation effect to use for notifications.
-
Possible values: scale slide genie jelly flip exploader bouncyflip -
Default value: slide -
alert_effectThe animation effect to use for alerts.
-
Possible values: scale slide genie jelly flip exploader bouncyflip -
Default value: jelly -
display_timeTime a notification is displayed in milliseconds.
-
Possible values: int -
Default value: 3500 -
positionPosition where the notifications should be displayed.
-
Possible values: left center right -
Default value: center -
welcome_messageMessage shown at startup.
-
Possible values: string false -
Default value: false (no message at startup) -
+| Option | Description +| ----------------- | ----------- +| `effect` | The animation effect to use for notifications.

**Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip`
**Default value:** `slide` +| `alert_effect` | The animation effect to use for alerts.

**Possible values:** `scale` `slide` `genie` `jelly` `flip` `exploader` `bouncyflip`
**Default value:** `jelly` +| `display_time` | Time a notification is displayed in milliseconds.

**Possible values:** `int`
**Default value:** `3500` +| `position` | Position where the notifications should be displayed.

**Possible values:** `left` `center` `right`
**Default value:** `center` +| `welcome_message` | Message shown at startup.

**Possible values:** `string` `false`
**Default value:** `false` (no message at startup) ## Developer notes @@ -82,83 +43,21 @@ self.sendNotification("SHOW_ALERT", {}); ``` ### Notification params - - - - - - - - - - - - - - - - - - -
OptionDescription
titleThe title of the notification.
-
Possible values: text or html -
messageThe message of the notification.
-
Possible values: text or html -
+| Option | Description +| --------- | ----------- +| `title` | The title of the notification.

**Possible values:** `text` or `html` +| `message` | The message of the notification.

**Possible values:** `text` or `html` + ### Alert params - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
titleThe title of the alert.
-
Possible values: text or html -
messageThe message of the alert.
-
Possible values: text or html -
imageUrl (optional)Image to show in the alert
-
Possible values: url path -
Default value: none -
imageFA (optional)Font Awesome icon to show in the alert
-
Possible values: See Font Awsome website. -
Default value: none -
imageHeight (optional even with imageUrl set)Height of the image
-
Possible values: intpx -
Default value: 80px -
timer (optional)How long the alert should stay visible in ms. -
Important: If you do not use the timer, it is your duty to hide the alert by using self.sendNotification("HIDE_ALERT");!
-
Possible values: int float -
Default value: none -
+| Option | Description +| ----------------------------------------------- | ----------- +| `title` | The title of the alert.

**Possible values:** `text` or `html` +| `message` | The message of the alert.

**Possible values:** `text` or `html` +| `imageUrl` (optional) | Image to show in the alert

**Possible values:** `url` `path`
**Default value:** `none` +| `imageFA` (optional) | Font Awesome icon to show in the alert

**Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website.
**Default value:** `none` +| `imageHeight` (optional even with imageUrl set) | Height of the image

**Possible values:** `intpx`
**Default value:** `80px` +| `timer` (optional) | How long the alert should stay visible in ms.
**Important:** If you do not use the `timer`, it is your duty to hide the alert by using `self.sendNotification("HIDE_ALERT");`!

**Possible values:** `int` `float`
**Default value:** `none` ## Open Source Licenses ###[NotificationStyles](https://github.com/codrops/NotificationStyles) diff --git a/modules/default/calendar/README.md b/modules/default/calendar/README.md index c5745152ee..06b7dd9c7f 100644 --- a/modules/default/calendar/README.md +++ b/modules/default/calendar/README.md @@ -24,152 +24,26 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
maximumEntriesThe maximum number of events shown.
-
Possible values: 0 - 100 -
Default value: 10 -
maximumNumberOfDaysThe maximum number of days in the future.
-
Default value: 365 -
displaySymbolDisplay a symbol in front of an entry.
-
Possible values: true or false -
Default value: true -
defaultSymbolThe default symbol.
-
Possible values: See Font Awsome website. -
Default value: calendar -
maxTitleLengthThe maximum title length.
-
Possible values: 10 - 50 -
Default value: 25 -
fetchIntervalHow often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000 -
Default value: 300000 (5 minutes) -
animationSpeedSpeed of the update animation. (Milliseconds)
-
Possible values:0 - 5000 -
Default value: 2000 (2 seconds) -
fadeFade the future events to black. (Gradient)
-
Possible values: true or false -
Default value: true -
fadePointWhere to start fade?
-
Possible values: 0 (top of the list) - 1 (bottom of list) -
Default value: 0.25 -
calendarsThe list of calendars.
-
Possible values: An array, see calendar configuration below. -
Default value: An example calendar. -
titleReplaceAn object of textual replacements applied to the tile of the event. This allow to remove or replace certains words in the title.
-
Example:
- - titleReplace: {'Birthday of ' : '', 'foo':'bar'} - -
Default value: - - { - "De verjaardag van ": "", - "'s birthday": "" - } - -
displayRepeatingCountTitleShow count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary")
-
Possible values: true or false -
Default value: false -
dateFormatFormat to use for the date of events (when using absolute dates)
-
Possible values: See Moment.js formats -
Default value: MMM Do (e.g. Jan 18th) -
timeFormatDisplay event times as absolute dates, or relative time
-
Possible values: absolute or relative -
Default value: relative -
getRelativeHow much time (in hours) should be left until calendar events start getting relative?
-
Possible values: 0 (events stay absolute) - 48 (48 hours before the event starts) -
Default value: 6 -
urgencyWhen 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
-
Possible values: a positive integer representing the number of days for which you want a relative date, for example 7 (for 7 days)
-
Default value: 7 -
broadcastEventsIf 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.
-
Possible values: true, false
-
Default value: true -
hidePrivateHides private calendar events.
-
Possible values: true or false -
Default value: false -
+| Option | Description +| ---------------------------- | ----------- +| `maximumEntries` | The maximum number of events shown. / **Possible values:** `0` - `100`
**Default value:** `10` +| `maximumNumberOfDays` | The maximum number of days in the future.

**Default value:** `365` +| `displaySymbol` | Display a symbol in front of an entry.

**Possible values:** `true` or `false`
**Default value:** `true` +| `defaultSymbol` | The default symbol.

**Possible values:** See [Font Awsome](http://fontawesome.io/icons/) website.
**Default value:** `calendar` +| `maxTitleLength` | The maximum title length.

**Possible values:** `10` - `50`
**Default value:** `25` +| `fetchInterval` | How often does the content needs to be fetched? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `300000` (5 minutes) +| `animationSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `2000` (2 seconds) +| `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` +| `calendars` | The list of calendars.

**Possible values:** An array, see _calendar configuration_ below.
**Default value:** _An example calendar._ +| `titleReplace` | An object of textual replacements applied to the tile of the event. This allow to remove or replace certains words in the title.

**Example:** `{'Birthday of ' : '', 'foo':'bar'}`
**Default value:** `{ "De verjaardag van ": "", "'s birthday": "" }` +| `displayRepeatingCountTitle` | Show count title for yearly repeating events (e.g. "X. Birthday", "X. Anniversary")

**Possible values:** `true` or `false`
**Default value:** `false` +| `dateFormat` | Format to use for the date of events (when using absolute dates)

**Possible values:** See [Moment.js formats](http://momentjs.com/docs/#/parsing/string-format/)
**Default value:** `MMM Do` (e.g. Jan 18th) +| `timeFormat` | Display event times as absolute dates, or relative time

**Possible values:** `absolute` or `relative`
**Default value:** `relative` +| `getRelative` | How much time (in hours) should be left until calendar events start getting relative?

**Possible values:** `0` (events stay absolute) - `48` (48 hours before the event starts)
**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

**Possible values:** a positive integer representing the number of days for which you want a relative date, for example `7` (for 7 days)

**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`.

**Possible values:** `true`, `false`

**Default value:** `true` +| `hidePrivate` | Hides private calendar events.

**Possible values:** `true` or `false`
**Default value:** `false` ### Calendar configuration @@ -189,41 +63,10 @@ config: { #### Calendar configuration options: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
urlThe url of the calendar .ical. This property is required.
-
Possible values: Any public accessble .ical calendar. -
symbolThe symbol to show in front of an event. This property is optional.
-
Possible values: See Font Awesome website. -
repeatingCountTitleThe count title for yearly repating events in this calendar.
-
Example:
- 'Birthday' -
userThe username for HTTP Basic authentication.
passThe password for HTTP Basic authentication.
+| Option | Description +| --------------------- | ----------- +| `url` | The url of the calendar .ical. This property is required.

**Possible values:** Any public accessble .ical calendar. +| `symbol` | The symbol to show in front of an event. This property is optional.

**Possible values:** See [Font Awesome](http://fontawesome.io/icons/) website. +| `repeatingCountTitle` | The count title for yearly repating events in this calendar.

**Example:** `'Birthday'` +| `user` | The username for HTTP Basic authentication. +| `pass` | The password for HTTP Basic authentication. diff --git a/modules/default/clock/README.md b/modules/default/clock/README.md index 76a979d4ba..9bd0bafd77 100644 --- a/modules/default/clock/README.md +++ b/modules/default/clock/README.md @@ -22,106 +22,18 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
timeFormatUse 12 or 24 hour format.
-
Possible values: 12 or 24 -
Default value: uses value of config.timeFormat -
displaySecondsDisplay seconds.
-
Possible values: true or false -
Default value: true -
showPeriodShow the period (am/pm) with 12 hour format.
-
Possible values: true or false -
Default value: true -
showPeriodUpperShow the period (AM/PM) with 12 hour format as uppercase.
-
Possible values: true or false -
Default value: false -
clockBoldRemove the colon and bold the minutes to make a more modern look.
-
Possible values: true or false -
Default value: false -
showDateTurn off or on the Date section.
-
Possible values: true or false -
Default value: true -
displayTypeDisplay a digital clock, analog clock, or both together.
-
Possible values: digital, analog, or both -
Default value: digital -
analogSizeSpecific to the analog clock. Defines how large the analog display is.
-
Possible values: A positive number of pixels -
Default value: 200px -
analogFaceSpecific to the analog clock. Specifies which clock face to use.
-
Possible values: simple for a simple border, none for no face or border, or face-### (where ### is currently a value between 001 and 012, inclusive) -
Default value: simple -
secondsColorSpecific to the analog clock. Specifies what color to make the 'seconds' hand.
-
Possible values: any HTML RGB Color -
Default value: #888888 -
analogPlacementSpecific to the analog clock. (requires displayType set to 'both') Specifies where the analog clock is in relation to the digital clock
-
Possible values: top, right, bottom, or left -
Default value: bottom -
analogShowDateSpecific to the analog clock. If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock.
-
Possible values: false, top, or bottom -
Default value: top -
timezoneSpecific a timezone to show clock.
-
Possible examples values: America/New_York, America/Santiago, Etc/GMT+10 -
Default value: none -
+| Option | Description +| ----------------- | ----------- +| `timeFormat` | Use 12 or 24 hour format.

**Possible values:** `12` or `24`
**Default value:** uses value of _config.timeFormat_ +| `displaySeconds` | Display seconds.

**Possible values:** `true` or `false`
**Default value:** `true` +| `showPeriod` | Show the period (am/pm) with 12 hour format.

**Possible values:** `true` or `false`
**Default value:** `true` +| `showPeriodUpper` | Show the period (AM/PM) with 12 hour format as uppercase.

**Possible values:** `true` or `false`
**Default value:** `false` +| `clockBold` | Remove the colon and bold the minutes to make a more modern look.

**Possible values:** `true` or `false`
**Default value:** `false` +| `showDate` | Turn off or on the Date section.

**Possible values:** `true` or `false`
**Default value:** `true` +| `displayType` | Display a digital clock, analog clock, or both together.

**Possible values:** `digital`, `analog`, or `both`
**Default value:** `digital` +| `analogSize` | **Specific to the analog clock.** Defines how large the analog display is.

**Possible values:** A positive number of pixels`
**Default value:** `200px` +| `analogFace` | **Specific to the analog clock.** Specifies which clock face to use.

**Possible values:** `simple` for a simple border, `none` for no face or border, or `face-###` (where ### is currently a value between 001 and 012, inclusive)
**Default value:** `simple` +| `secondsColor` | **Specific to the analog clock.** Specifies what color to make the 'seconds' hand.

**Possible values:** `any HTML RGB Color`
**Default value:** `#888888` +| `analogPlacement` | **Specific to the analog clock. _(requires displayType set to `'both'`)_** Specifies where the analog clock is in relation to the digital clock

**Possible values:** `top`, `right`, `bottom`, or `left`
**Default value:** `bottom` +| `analogShowDate` | **Specific to the analog clock.** If the clock is used as a separate module and set to analog only, this configures whether a date is also displayed with the clock.

**Possible values:** `false`, `top`, or `bottom`
**Default value:** `top` +| `timezone` | Specific a timezone to show clock.

**Possible examples values:** `America/New_York`, `America/Santiago`, `Etc/GMT+10`
**Default value:** `none` diff --git a/modules/default/compliments/README.md b/modules/default/compliments/README.md index 430c4fbfa5..d8be85d2f4 100644 --- a/modules/default/compliments/README.md +++ b/modules/default/compliments/README.md @@ -25,48 +25,12 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
updateIntervalHow often does the compliment have to change? (Milliseconds)
-
Possible values: 1000 - 86400000 -
Default value: 30000 (30 seconds) -
fadeSpeedSpeed of the update animation. (Milliseconds)
-
Possible values:0 - 5000 -
Default value: 4000 (4 seconds) -
complimentsThe list of compliments.
-
Possible values: An object with three arrays: morning, afternoon andevening. See compliment configuration below. -
Default value: See compliment configuration below. -
remoteFileExternal file from which to load the compliments
-
Possible values:Path to a JSON file containing compliments, configured - as per the value of the compliments configuration (see below). An object with three arrays: - morning, afternoon and evening. - compliments.json -
Default value: null (Do not load from file) -
+| Option | Description +| ---------------- | ----------- +| `updateInterval` | How often does the compliment have to change? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `30000` (30 seconds) +| `fadeSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `4000` (4 seconds) +| `compliments` | The list of compliments.

**Possible values:** An object with three arrays: `morning`, `afternoon` and`evening`. See _compliment configuration_ below.
**Default value:** See _compliment configuration_ below. +| `remoteFile` | External file from which to load the compliments

**Possible values:** Path to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An object with three arrays: `morning`, `afternoon` and `evening`. - `compliments.json`
**Default value:** `null` (Do not load from file) ### Compliment configuration @@ -74,22 +38,22 @@ The `compliments` property contains an object with three arrays: morningday_sunny -* day_cloudy -* cloudy -* cloudy_windy -* showers -* rain -* thunderstorm -* snow -* fog -* night_clear -* night_cloudy -* night_showers -* night_rain -* night_thunderstorm -* night_snow -* night_alt_cloudy_windy +* `day_sunny` +* `day_cloudy` +* `cloudy` +* `cloudy_windy` +* `showers` +* `rain` +* `thunderstorm` +* `snow` +* `fog` +* `night_clear` +* `night_cloudy` +* `night_showers` +* `night_rain` +* `night_thunderstorm` +* `night_snow` +* `night_alt_cloudy_windy` #### Example use with currentweather module ````javascript diff --git a/modules/default/currentweather/README.md b/modules/default/currentweather/README.md index ccef543cd6..36a8a436bc 100644 --- a/modules/default/currentweather/README.md +++ b/modules/default/currentweather/README.md @@ -26,189 +26,52 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
locationThe location used for weather information.
-
Example: 'Amsterdam,Netherlands' -
Default value: false

- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. -
locationIDLocation ID from OpenWeatherMap This will override anything you put in location.
Leave blank if you want to use location. -
Example: 1234567 -
Default value: false

- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. -
appidThe OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
-
This value is REQUIRED -
unitsWhat 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 -
roundTempRound temperature value to nearest integer.
-
Possible values: true (round to integer) or false (display exact value with decimal point) -
Default value: false -
updateIntervalHow often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000 -
Default value: 600000 (10 minutes) -
animationSpeedSpeed of the update animation. (Milliseconds)
-
Possible values:0 - 5000 -
Default value: 1000 (1 second) -
timeFormatUse 12 or 24 hour format.
-
Possible values: 12 or 24 -
Default value: uses value of config.timeFormat -
showPeriodShow the period (am/pm) with 12 hour format
-
Possible values: true or false -
Default value: true -
showPeriodUpperShow the period (AM/PM) with 12 hour format as uppercase
-
Possible values: true or false -
Default value: false -
showWindDirectionShow the wind direction next to the wind speed.
-
Possible values: true or false -
Default value: true -
showHumidityShow the current humidity
-
Possible values: true or false -
Default value: false -
onlyTempShow only current Temperature and weather icon.
-
Possible values: true or false -
Default value: false -
useBeaufortPick between using the Beaufort scale for wind speed or using the default units.
-
Possible values: true or false -
Default value: true -
langThe language of the days.
-
Possible values: en, nl, ru, etc ... -
Default value: uses value of config.language -
initialLoadDelayThe 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 -
retryDelayThe delay before retrying after a request failure. (Milliseconds)
-
Possible values: 1000 - 60000 -
Default value: 2500 -
apiVersionThe OpenWeatherMap API version to use.
-
Default value: 2.5 -
apiBaseThe OpenWeatherMap base URL.
-
Default value: 'http://api.openweathermap.org/data/' -
weatherEndpointThe OpenWeatherMap API endPoint.
-
Default value: 'weather' -
appendLocationNameToHeaderIf set to true, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
-
Default value: true -
calendarClassThe class for the calender module to base the event based weather information on.
-
Default value: 'calendar' -
iconTableThe conversion table to convert the weather conditions to weather-icons.
-
Default value: iconTable: { - '01d':'wi-day-sunny', - '02d':'wi-day-cloudy', - '03d':'wi-cloudy', - '04d':'wi-cloudy-windy', - '09d':'wi-showers', - '10d':'wi-rain', - '11d':'wi-thunderstorm', - '13d':'wi-snow', - '50d':'wi-fog', - '01n':'wi-night-clear', - '02n':'wi-night-cloudy', - '03n':'wi-night-cloudy', - '04n':'wi-night-cloudy', - '09n':'wi-night-showers', - '10n':'wi-night-rain', - '11n':'wi-night-thunderstorm', - '13n':'wi-night-snow', - '50n':'wi-night-alt-cloudy-windy' - } -
+| Option | Description +| ---------------------------- | ----------- +| `location` | The location used for weather information.

**Example:** `'Amsterdam,Netherlands'`
**Default value:** `false`

**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. +| `locationID` | Location ID from [OpenWeatherMap](http://openweathermap.org/help/city_list.txt) **This will override anything you put in location.**
Leave blank if you want to use location.
**Example:** `1234567`
**Default value:** `false`

**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. +| `appid` | The [OpenWeatherMap](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account.

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` +| `roundTemp` | Round temperature value to nearest integer.

**Possible values:** `true` (round to integer) or `false` (display exact value with decimal point)
**Default value:** `false` +| `updateInterval` | How often does the content needs to be fetched? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `600000` (10 minutes) +| `animationSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `1000` (1 second) +| `timeFormat` | Use 12 or 24 hour format.

**Possible values:** `12` or `24`
**Default value:** uses value of _config.timeFormat_ +| `showPeriod` | Show the period (am/pm) with 12 hour format

**Possible values:** `true` or `false`
**Default value:** `true` +| `showPeriodUpper` | Show the period (AM/PM) with 12 hour format as uppercase

**Possible values:** `true` or `false`
**Default value:** `false` +| `showWindDirection` | Show the wind direction next to the wind speed.

**Possible values:** `true` or `false`
**Default value:** `true` +| `showHumidity` | Show the current humidity

**Possible values:** `true` or `false`
**Default value:** `false` +| `onlyTemp` | Show only current Temperature and weather icon.

**Possible values:** `true` or `false`
**Default value:** `false` +| `useBeaufort` | Pick between using the Beaufort scale for wind speed or using the default units.

**Possible values:** `true` or `false`
**Default value:** `true` +| `lang` | The language of the days.

**Possible values:** `en`, `nl`, `ru`, etc ...
**Default value:** uses value of _config.language_ +| `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` +| `apiVersion` | The OpenWeatherMap API version to use.

**Default value:** `2.5` +| `apiBase` | The OpenWeatherMap base URL.

**Default value:** `'http://api.openweathermap.org/data/'` +| `weatherEndpoint` | The OpenWeatherMap API endPoint.

**Default value:** `'weather'` +| `appendLocationNameToHeader` | If set to `true`, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.

**Default value:** `true` +| `calendarClass` | The class for the calender module to base the event based weather information on.

**Default value:** `'calendar'` +| `iconTable` | The conversion table to convert the weather conditions to weather-icons.

**Default value:** view tabel below. + +#### Default Icon Table +````javascript +iconTable: { + '01d': 'wi-day-sunny', + '02d': 'wi-day-cloudy', + '03d': 'wi-cloudy', + '04d': 'wi-cloudy-windy', + '09d': 'wi-showers', + '10d': 'wi-rain', + '11d': 'wi-thunderstorm', + '13d': 'wi-snow', + '50d': 'wi-fog', + '01n': 'wi-night-clear', + '02n': 'wi-night-cloudy', + '03n': 'wi-night-cloudy', + '04n': 'wi-night-cloudy', + '09n': 'wi-night-showers', + '10n': 'wi-night-rain', + '11n': 'wi-night-thunderstorm', + '13n': 'wi-night-snow', + '50n': 'wi-night-alt-cloudy-windy' +} +```` diff --git a/modules/default/helloworld/README.md b/modules/default/helloworld/README.md index 72e7d023a9..bcbd57fcaa 100644 --- a/modules/default/helloworld/README.md +++ b/modules/default/helloworld/README.md @@ -20,23 +20,6 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - - - -
OptionDescription
textThe text to display.
-
Example: 'Hello world!' -
Default value: 'Hello world!' -
+| Option | Description +| ------ | ----------- +| `text` | The text to display.

**Example:** `'Hello world!'`
**Default value:** `'Hello world!'` diff --git a/modules/default/newsfeed/README.md b/modules/default/newsfeed/README.md index 8a0fec2534..2084080663 100644 --- a/modules/default/newsfeed/README.md +++ b/modules/default/newsfeed/README.md @@ -33,37 +33,14 @@ modules: [ ### Notifications #### Interacting with the module -MagicMirror's [notification mechanism](https://github.com/MichMich/MagicMirror/tree/master/modules#thissendnotificationnotification-payload) allows to send notifications to the ````newsfeed```` module. The following notifications are supported: +MagicMirror's [notification mechanism](https://github.com/MichMich/MagicMirror/tree/master/modules#thissendnotificationnotification-payload) allows to send notifications to the `newsfeed` module. The following notifications are supported: - - - - - - - - - - - - - - - - - - - - - - - - - - -
Notification IdentifierDescription
ARTICLE_NEXTShows the next news title (hiding the summary or previously fully displayed article)
ARTICLE_PREVIOUSShows the previous news title (hiding the summary or previously fully displayed article)
ARTICLE_MORE_DETAILS

When received the *first time*, shows the corresponding description of the currently displayed news title.
The module expects that the module's configuration option ````showDescription```` is set to ````false```` (default value).

- When received a *second consecutive time*, shows the full news article in an IFRAME.
- This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. ````DENY````.
ARTICLE_LESS_DETAILSHides the summary or full news article and only displays the news title of the currently viewed news item.
+| Notification Identifier | Description +| ----------------------- | ----------- +| `ARTICLE_NEXT` | Shows the next news title (hiding the summary or previously fully displayed article) +| `ARTICLE_PREVIOUS` | Shows the previous news title (hiding the summary or previously fully displayed article) +| `ARTICLE_MORE_DETAILS` | When received the _first time_, shows the corresponding description of the currently displayed news title.
The module expects that the module's configuration option `showDescription` is set to `false` (default value).

When received a _second consecutive time_, shows the full news article in an IFRAME.
This requires that the news page can be embedded in an IFRAME, e.g. doesn't have the HTTP response header [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) set to e.g. `DENY`. +| `ARTICLE_LESS_DETAILS` | Hides the summary or full news article and only displays the news title of the currently viewed news item. Note the payload of the sent notification event is ignored. @@ -73,155 +50,32 @@ The following example shows how the next news article title can be displayed on this.sendNotification('ARTICLE_NEXT'); ```` -#### ````newsfeed```` specific notification emitting modules +#### `newsfeed` specific notification emitting modules The third party [MMM-Gestures](https://github.com/thobach/MMM-Gestures) module supports above notifications when moving your hand up, down, left or right in front of a gesture sensor attached to the MagicMirror. See module's readme for more details. ## Configuration options The following properties can be configured: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - removeStartTags: false, - removeEndTags: false, - startTags: [], - endTags: [] - - - - - - - - - - - - - - - - - - - -
OptionDescription
feedsAn array of feed urls that will be used as source.
- More info about this object can be found below. -
Default value: [ - { - title: "New York Times", - url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml", - encoding: "UTF-8" - } - ] -
showSourceTitleDisplay the title of the source.
-
Possible values: true or false -
Default value: true -
showPublishDateDisplay the publish date of an headline.
-
Possible values: true or false -
Default value: true -
showDescriptionDisplay the description of an item.
-
Possible values: true or false -
Default value: false -
reloadIntervalHow often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000 -
Default value: 300000 (5 minutes) -
updateIntervalHow often do you want to display a new headline? (Milliseconds)
-
Possible values:1000 - 60000 -
Default value: 10000 (10 seconds) -
animationSpeedSpeed of the update animation. (Milliseconds)
-
Possible values:0 - 5000 -
Default value: 2500 (2.5 seconds) -
maxNewsItemsTotal amount of news items to cycle through. (0 for unlimited)
-
Possible values:0 - ... -
Default value: 0 -
removeStartTagsSome newsfeeds feature tags at the beginning of their titles or descriptions, such as [VIDEO]. - This setting allows for the removal of specified tags from the beginning of an item's description and/or title.
-
Possible values:'title', 'description', 'both' -
startTagsList the tags you would like to have removed at the beginning of the feed item
-
Possible values: ['TAG'] or ['TAG1','TAG2',...] -
removeEndTagsRemove specified tags from the end of an item's description and/or title.
-
Possible values:'title', 'description', 'both' -
endTagsList the tags you would like to have removed at the end of the feed item
-
Possible values: ['TAG'] or ['TAG1','TAG2',...] -
+| Option | Description +| ----------------- | ----------- +| `feeds` | An array of feed urls that will be used as source.
More info about this object can be found below.
**Default value:** `[{ title: "New York Times", url: "http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml", encoding: "UTF-8" }]` +| `showSourceTitle` | Display the title of the source.

**Possible values:** `true` or `false`
**Default value:** `true` +| `showPublishDate` | Display the publish date of an headline.

**Possible values:** `true` or `false`
**Default value:** `true` +| `showDescription` | Display the description of an item.

**Possible values:** `true` or `false`
**Default value:** `false` +| `reloadInterval` | How often does the content needs to be fetched? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `300000` (5 minutes) +| `updateInterval` | How often do you want to display a new headline? (Milliseconds)

**Possible values:**`1000` - `60000`
**Default value:** `10000` (10 seconds) +| `animationSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `2500` (2.5 seconds) +| `maxNewsItems` | Total amount of news items to cycle through. (0 for unlimited)

**Possible values:**`0` - `...`
**Default value:** `0` +| `removeStartTags` | Some newsfeeds feature tags at the **beginning** of their titles or descriptions, such as _[VIDEO]_. This setting allows for the removal of specified tags from the beginning of an item's description and/or title.

**Possible values:**`'title'`, `'description'`, `'both'` +| `startTags` | List the tags you would like to have removed at the beginning of the feed item

**Possible values:** `['TAG']` or `['TAG1','TAG2',...]` +| `removeEndTags` | Remove specified tags from the **end** of an item's description and/or title.

**Possible values:**`'title'`, `'description'`, `'both'` +| `endTags` | List the tags you would like to have removed at the end of the feed item

**Possible values:** `['TAG']` or `['TAG1','TAG2',...]` The `feeds` property contains an array with multiple objects. These objects have the following properties: - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
titleThe name of the feed source to be displayed above the news items.
-
This property is optional. -
urlThe url of the feed used for the headlines.
-
Example: 'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml' -
encodingThe encoding of the news feed.
-
This property is optional. -
Possible values:'UTF-8', 'ISO-8859-1', etc ... -
Default value: 'UTF-8' -
+| Option | Description +| ---------- | ----------- +| `title` | The name of the feed source to be displayed above the news items.

This property is optional. +| `url` | The url of the feed used for the headlines.

**Example:** `'http://www.nytimes.com/services/xml/rss/nyt/HomePage.xml'` +| `encoding` | The encoding of the news feed.

This property is optional.
**Possible values:**`'UTF-8'`, `'ISO-8859-1'`, etc ...
**Default value:** `'UTF-8'` diff --git a/modules/default/updatenotification/README.md b/modules/default/updatenotification/README.md index 7d839087c2..16a1b0c2a7 100644 --- a/modules/default/updatenotification/README.md +++ b/modules/default/updatenotification/README.md @@ -22,21 +22,6 @@ modules: [ The following properties can be configured: - - - - - - - - - - - - - - -
OptionDescription
updateIntervalHow often do you want to check for a new version? This value represents the interval in milliseconds.
-
Possible values: Any value above 60000 (1 minute); -
Default value: 600000 (10 minutes); -
\ No newline at end of file +| Option | Description +| ---------------- | ----------- +| `updateInterval` | How often do you want to check for a new version? This value represents the interval in milliseconds.

**Possible values:** Any value above `60000` (1 minute)
**Default value:** `600000` (10 minutes); diff --git a/modules/default/weatherforecast/README.md b/modules/default/weatherforecast/README.md index 2842af54f1..e2cc502827 100644 --- a/modules/default/weatherforecast/README.md +++ b/modules/default/weatherforecast/README.md @@ -25,171 +25,49 @@ modules: [ The following properties can be configured: +| Option | Description +| ---------------------------- | ----------- +| `location` | The location used for weather information.

**Example:** `'Amsterdam,Netherlands'`
**Default value:** `false`

**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. +| `locationID` | Location ID from [OpenWeatherMap](http://openweathermap.org/help/city_list.txt) **This will override anything you put in location.**
Leave blank if you want to use location.
**Example:** `1234567`
**Default value:** `false`

**Note:** When the `location` and `locationID` are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. +| `appid` | The [OpenWeatherMap](https://home.openweathermap.org) API key, which can be obtained by creating an OpenWeatherMap account.

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` +| `roundTemp` | Round temperature values to nearest integer.

**Possible values:** `true` (round to integer) or `false` (display exact value with decimal point)
**Default value:** `false` +| `maxNumberOfDays` | How many days of forecast to return. Specified by config.js

**Possible values:** `1` - `16`
**Default value:** `7` (7 days)
This value is optional. By default the weatherforecast module will return 7 days. +| `showRainAmount` | Should the predicted rain amount be displayed?

**Possible values:** `true` or `false`
**Default value:** `false`
This value is optional. By default the weatherforecast module will not display the predicted amount of rain. +| `updateInterval` | How often does the content needs to be fetched? (Milliseconds)

**Possible values:** `1000` - `86400000`
**Default value:** `600000` (10 minutes) +| `animationSpeed` | Speed of the update animation. (Milliseconds)

**Possible values:**`0` - `5000`
**Default value:** `1000` (1 second) +| `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:** `2500` (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.) +| `retryDelay` | The delay before retrying after a request failure. (Milliseconds)

**Possible values:** `1000` - `60000`
**Default value:** `2500` +| `apiVersion` | The OpenWeatherMap API version to use.

**Default value:** `2.5` +| `apiBase` | The OpenWeatherMap base URL.

**Default value:** `'http://api.openweathermap.org/data/'` +| `forecastEndpoint` | The OpenWeatherMap API endPoint.

**Default value:** `'forecast/daily'` +| `appendLocationNameToHeader` | If set to `true`, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.

**Default value:** `true` +| `calendarClass` | The class for the calender module to base the event based weather information on.

**Default value:** `'calendar'` +| `iconTable` | The conversion table to convert the weather conditions to weather-icons.

**Default value:** view table below - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OptionDescription
locationThe location used for weather information.
-
Example: 'Amsterdam,Netherlands' -
Default value: false

- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. -
locationIDLocation ID from OpenWeatherMap This will override anything you put in location.
Leave blank if you want to use location. -
Example: 1234567 -
Default value: false

- Note: When the location and locationID are both not set, the location will be based on the information provided by the calendar module. The first upcoming event with location data will be used. -
appidThe OpenWeatherMap API key, which can be obtained by creating an OpenWeatherMap account.
-
This value is REQUIRED -
unitsWhat 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 -
roundTempRound temperature values to nearest integer.
-
Possible values: true (round to integer) or false (display exact value with decimal point) -
Default value: false -
maxNumberOfDaysHow many days of forecast to return. Specified by config.js
-
Possible values: 1 - 16 -
Default value: 7 (7 days) -
This value is optional. By default the weatherforecast module will return 7 days. -
showRainAmountShould the predicted rain amount be displayed?
-
Possible values: true or false -
Default value: false -
This value is optional. By default the weatherforecast module will not display the predicted amount of rain. -
updateIntervalHow often does the content needs to be fetched? (Milliseconds)
-
Possible values: 1000 - 86400000 -
Default value: 600000 (10 minutes) -
animationSpeedSpeed of the update animation. (Milliseconds)
-
Possible values:0 - 5000 -
Default value: 1000 (1 second) -
langThe language of the days.
-
Possible values: en, nl, ru, etc ... -
Default value: uses value of config.language -
fadeFade the future events to black. (Gradient)
-
Possible values: true or false -
Default value: true -
fadePointWhere to start fade?
-
Possible values: 0 (top of the list) - 1 (bottom of list) -
Default value: 0.25 -
initialLoadDelayThe 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: 2500 (2.5 seconds delay. This delay is used to keep the OpenWeather API happy.) -
retryDelayThe delay before retrying after a request failure. (Milliseconds)
-
Possible values: 1000 - 60000 -
Default value: 2500 -
apiVersionThe OpenWeatherMap API version to use.
-
Default value: 2.5 -
apiBaseThe OpenWeatherMap base URL.
-
Default value: 'http://api.openweathermap.org/data/' -
forecastEndpointThe OpenWeatherMap API endPoint.
-
Default value: 'forecast/daily' -
appendLocationNameToHeaderIf set to true, the returned location name will be appended to the header of the module, if the header is enabled. This is mainly intresting when using calender based weather.
-
Default value: true -
calendarClassThe class for the calender module to base the event based weather information on.
-
Default value: 'calendar' -
iconTableThe conversion table to convert the weather conditions to weather-icons.
-
Default value: iconTable: { - '01d':'wi-day-sunny', - '02d':'wi-day-cloudy', - '03d':'wi-cloudy', - '04d':'wi-cloudy-windy', - '09d':'wi-showers', - '10d':'wi-rain', - '11d':'wi-thunderstorm', - '13d':'wi-snow', - '50d':'wi-fog', - '01n':'wi-night-clear', - '02n':'wi-night-cloudy', - '03n':'wi-night-cloudy', - '04n':'wi-night-cloudy', - '09n':'wi-night-showers', - '10n':'wi-night-rain', - '11n':'wi-night-thunderstorm', - '13n':'wi-night-snow', - '50n':'wi-night-alt-cloudy-windy' - } -
+#### Default Icon Table +````javascript +iconTable: { + '01d': 'wi-day-sunny', + '02d': 'wi-day-cloudy', + '03d': 'wi-cloudy', + '04d': 'wi-cloudy-windy', + '09d': 'wi-showers', + '10d': 'wi-rain', + '11d': 'wi-thunderstorm', + '13d': 'wi-snow', + '50d': 'wi-fog', + '01n': 'wi-night-clear', + '02n': 'wi-night-cloudy', + '03n': 'wi-night-cloudy', + '04n': 'wi-night-cloudy', + '09n': 'wi-night-showers', + '10n': 'wi-night-rain', + '11n': 'wi-night-thunderstorm', + '13n': 'wi-night-snow', + '50n': 'wi-night-alt-cloudy-windy' +} +```` From 0734e136d0f9c347819fcbf12f13800131aa271f Mon Sep 17 00:00:00 2001 From: Brian Date: Tue, 17 Jan 2017 16:15:39 +0100 Subject: [PATCH 2/2] Update CHANGELOG --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a01840c9a9..459779a833 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ This project adheres to [Semantic Versioning](http://semver.org/). - Switched out `rrule` package for `rrule-alt` in order to improve calendar issues. (Experimental: [#565](https://github.com/MichMich/MagicMirror/issues/565)) - Make mouse events pass through the region fullscreen_above to modules below. - Scaled the splash screen down to make it a bit more subtle. +- Replace HTML tables with markdown tables in README files. ### Added - Add loaded function to modules, providing an async callback.