mirror of
https://github.com/MichMich/MagicMirror.git
synced 2025-06-27 11:50:00 +00:00
Add documentation.
This commit is contained in:
Michael Teeuw
parent
46312cb44c
commit
68b3f1a8e6
142
modules/calendar/README.md
Normal file
142
modules/calendar/README.md
Normal file
@ -0,0 +1,142 @@
|
|||||||
|
# Module: Calendar
|
||||||
|
The `calendar` module is one of the default modules of the MagicMirror.
|
||||||
|
This module displays events from a public .ical calendar. It can combine multiple calendars.
|
||||||
|
|
||||||
|
## Using the module
|
||||||
|
|
||||||
|
To use this module, add it to the modules array in the `config/config.js` file:
|
||||||
|
````javascript
|
||||||
|
modules: [
|
||||||
|
{
|
||||||
|
module: 'calendar',
|
||||||
|
position: 'top_left', // This can be any of the regions. Best results in left or right regions.
|
||||||
|
config: {
|
||||||
|
// The config property is optional.
|
||||||
|
// If no config is set, an example calendar is shown.
|
||||||
|
// See 'Configuration options' for more information.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
````
|
||||||
|
|
||||||
|
## Configuration options
|
||||||
|
|
||||||
|
The following properties can be configured:
|
||||||
|
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<!-- why, markdown... -->
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Option</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>maximumEntries</code></td>
|
||||||
|
<td>The maximum number of events shown.<br>
|
||||||
|
<br><b>Possible values:</b> <code>0</code> - <code>100</code>
|
||||||
|
<br><b>Default value:</b> <code>10</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>displaySymbol</code></td>
|
||||||
|
<td>Display a symbol in front of an entry.<br>
|
||||||
|
<br><b>Possible values:</b> <code>true</code> or <code>false</code>
|
||||||
|
<br><b>Default value:</b> <code>true</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>defaultSymbol</code></td>
|
||||||
|
<td>The default symbol.<br>
|
||||||
|
<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
|
||||||
|
<br><b>Default value:</b> <code>calendar</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>maxTitleLength</code></td>
|
||||||
|
<td>The maximum title length.<br>
|
||||||
|
<br><b>Possible values:</b> <code>10</code> - <code>50</code>
|
||||||
|
<br><b>Default value:</b> <code>25</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>fetchInterval</code></td>
|
||||||
|
<td>How often does the content needs to be fetched? (Milliseconds)<br>
|
||||||
|
<br><b>Possible values:</b> <code>1000</code> - <code>86400000</code>
|
||||||
|
<br><b>Default value:</b> <code>30000</code> (5 minutes)
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>animationSpeed</code></td>
|
||||||
|
<td>Speed of the update animation. (Milliseconds)<br>
|
||||||
|
<br><b>Possible values:</b><code>0</code> - <code>5000</code>
|
||||||
|
<br><b>Default value:</b> <code>2000</code> (2 seconds)
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>fade</code></td>
|
||||||
|
<td>Fade the future events to black. (Gradient)<br>
|
||||||
|
<br><b>Possible values:</b> <code>true</code> or <code>false</code>
|
||||||
|
<br><b>Default value:</b> <code>true</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>fadePoint</code></td>
|
||||||
|
<td>Where to start fade?<br>
|
||||||
|
<br><b>Possible values:</b> <code>0</code> (top of the list) - <code>1</code> (bottom of list)
|
||||||
|
<br><b>Default value:</b> <code>0.25</code>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>calendars</code></td>
|
||||||
|
<td>The list of calendars.<br>
|
||||||
|
<br><b>Possible values:</b> An array, see <i>calendar configuration</i> below.
|
||||||
|
<br><b>Default value:</b> <i>An example calendar.</i>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
### Calendar configuration
|
||||||
|
|
||||||
|
The `calendar` property contains an array of the configured calendars.
|
||||||
|
|
||||||
|
#### Default value:
|
||||||
|
````javascript
|
||||||
|
config: {
|
||||||
|
calendars: [
|
||||||
|
{
|
||||||
|
url: 'http://www.calendarlabs.com/templates/ical/US-Holidays.ics',
|
||||||
|
symbol: 'calendar',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
````
|
||||||
|
|
||||||
|
|
||||||
|
#### Calendar configuration options:
|
||||||
|
<table>
|
||||||
|
<!-- why, markdown... -->
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Option</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>url</code></td>
|
||||||
|
<td>The url of the calendar .ical. This property is required.<br>
|
||||||
|
<br><b>Possible values:</b> Any public accessble .ical calendar.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code> symbol </code></td>
|
||||||
|
<td>The symbol to show in front of an event. This property is optional.<br>
|
||||||
|
<br><b>Possible values:</b> See <a href="http://fontawesome.io/icons/" target="_blank">Font Awsome</a> website.
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
49
modules/clock/README.md
Normal file
49
modules/clock/README.md
Normal file
@ -0,0 +1,49 @@
|
|||||||
|
# Module: Clock
|
||||||
|
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.
|
||||||
|
|
||||||
|
## Using the module
|
||||||
|
|
||||||
|
To use this module, add it to the modules array in the `config/config.js` file:
|
||||||
|
````javascript
|
||||||
|
modules: [
|
||||||
|
{
|
||||||
|
module: 'clock',
|
||||||
|
position: 'top_left', // This can be any of the regions.
|
||||||
|
config: {
|
||||||
|
// The config property is optional.
|
||||||
|
// See 'Configuration options' for more information.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
````
|
||||||
|
|
||||||
|
## Configuration options
|
||||||
|
|
||||||
|
The following properties can be configured:
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<!-- why, markdown... -->
|
||||||
|
<thead>
|
||||||
|
<tr>
|
||||||
|
<th>Option</th>
|
||||||
|
<th>Description</th>
|
||||||
|
</tr>
|
||||||
|
<thead>
|
||||||
|
<tbody>
|
||||||
|
<tr>
|
||||||
|
<td><code>timeFormat</code></td>
|
||||||
|
<td>Use 12 of 24 hour format.<br>
|
||||||
|
<br><b>Possible values:</b>
|
||||||
|
<br><b>Default value:</b>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>displaySeconds</code></td>
|
||||||
|
<td>Display seconds.<br>
|
||||||
|
<br><b>Possible values: <code>true</code> or <code>false</code></b>
|
||||||
|
<br><b>Default value: <code>true</code></b>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
Loading…
x
Reference in New Issue
Block a user