Skip to content

sabo10o29/MMM-TimeTreeEvent

Repository files navigation

MMM-TimeTreeEvent

Display your TimeTree event on your magic mirror.

Features

Screenshot

  • Sample screenshot 1
    Screenshot

  • Sample screenshot 2
    Screenshot

UPDATE

1.0.0

  • Simple viewer for TimeTree event.

1.0.1

  • Temporary fix: Add request lib.

1.0.2

  • Migrate to axios from request.

1.0.3

  • Added the feature to display the date at the head of the event.

Installation

cd ~/MagicMirror/modules/
git clone https://github.com/sabo10o29/MMM-TimeTreeEvent.git
cd MMM-TimeTreeEvent
npm install

Get timetreeapp.com API Key

https://timetreeapp.com/personal_access_tokens

Necessary Configuration

{
    module: "MMM-TimeTreeEvent",
    //Positions of *_bar and *_third are not support.
    position: "top_left",
    config: {
        appid: "***Your api key***",
        //You need to get the target calender id with Get calender id api[1]
        calenderid: "***Calender id***",
    }
},

[1] Get calender id api

Optional Configuration

Option Description
upadteinterval Update interval to get event from TimeTree.

Type: int
Default value: 3 * 60 * 60 *1000 (3 hours)
timeFormat Display the scheduled time based on moment.js.

Type: String
Default value: HH:mm
showDate If showDate is true, the date is displayed at the head of the event.

Type: boolean
Default value: false
dateFormat Display the scheduled date based on moment.js if showDate option is true.

Type: String
Default value: MM/DD
eventWordCount Maximum length to show the event title.

Type: int
Default value: 10
days Get events from today to n-th day.

Type: int
Default value: 1
title Title name

Type: String
Default value: Today's event  
timezone Timezone. The format is according to the Time Zone Database.

Type: String
Default value: Asia/Tokyo

About

Display your TimeTree event on your magic mirror.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published