A MagicMirror² module to display school calendars provided by LINQConnect.
cd ~/MagicMirror/modules
git clone https://github.com/dathbe/MMM-LINQConnectCalendar
cd MMM-LINQConnectCalendar
npm install --omit=devDependencies:
Note: running npm install is not strictly necessary unless the main MagicMirror² code is changed to eliminate the moment-timezone dependency.
cd ~/MagicMirror/modules/MMM-LINQConnectCalendar
git pull
npm install --omit=devAdd MMM-LINQConnectCalendar module to the modules array in the config/config.js file. The following example config shows a minimal configuration option. More options are described below.
{
module: "MMM-LINQConnectCalendar",
position: "top_right",
config: {
buildingId: '23125610-cbbc-eb11-a2cb-82fe13669c55',
districtId: '93f76ff0-2eb7-eb11-a2c4-e816644282bd',
}
},| Option | Description |
|---|---|
| buildingId | REQUIRED The buildingId for your school. See Finding your buildingId and districtId.Type: stringDefault: '' (empty string; will throw an error) |
| districtId | REQUIRED The districtId for your school. See Finding your buildingId and districtId.Type: stringDefault: '' (empty string; will throw an error) |
| noDays | The number of upcoming days you would like to display events for. Type: intDefault: 30 (will display all events for the next 30 days) |
| maxEntries | The maximum number of event entries you want to display. Type: intDefault: 99 (effectively, no limit) |
| dateFormat | The format you would like to use to display the date of the event. See Moment.js - Home for information on formatting dates. Type: stringDefault: 'MMM D' (e.g., "Jan 1") |
| dateHeader | The header you would like to use for the date column. Type: stringDefault: 'Date' |
| eventHeader | The header you would like to use for the event column. Type: stringDefault: 'Event' |
| updateInterval | Time (in minutes) between calendar updates. Type: intDefault value: 4 * 60 (4 hours) |
| filters | List of phrases that, if they are contained in the calendar entry description, will be excluded from the displayed table. For example, if you only wanted to see entries that applied to middle school, you might use filters: ['K-5', '9-12'], to exclude certain entries.Type: array of strsDefault value: [] |
If you find any problems, bugs or have questions, please open a GitHub issue in this repository.
Pull requests are of course also very welcome 🙂
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
You will need to first install the dev dependencies:
cd ~/MagicMirror/modules/MMM-LINQConnectCalendar
git switch development
npm installnode --run lint- Run linting checks.node --run lint:fix- Fix automatically fixable linting errors.
This project is licensed under the MIT License - see the LICENSE file for details.