tderflinger / MMM-Timetagger

Magic Mirror² module that shows the latest hours tracked by TimeTagger.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Magic Mirror² TimeTagger

Español

This is a Magic Mirror² module that shows the latest hours tracked by TimeTagger. TimeTagger is a time tracking application built by Almar Klein.

Specifically, it displays the following data:

  • hours worked this week
  • hours worked today
  • work in progress indicator (red circle)

In order to use this module, you need to have a TimeTagger account. You can also self-host TimeTagger as described in the TimeTagger documentation.

Preview Screenshot

This is an example of how Magic Mirror² TimeTagger looks in my configuration:

Magic Mirror² TimeTagger exmaple screen

Work in progress view when you are currently timetracking:

Magic Mirror² TimeTagger exmaple work in progress screen

Installation

Clone this repository into your MagicMirror modules folder.

Example:

cd /home/pi/MagicMirror/modules
git clone https://github.com/tderflinger/MMM-Timetagger.git

Install the JavaScript dependencies:

cd /home/pi/MagicMirror/modules/MMM-Timetagger
npm i

Finally, edit your configuration file under config/config.js with the following configuration.

{	
  module: "MMM-Timetagger",
  position: "top_left",
  config: {
	  endpoint: "Your API TimeTagger endpoint, like this: http://mymachine:8080/timetagger/api/v2",
	  apiToken: "Your API Token from TimeTagger",
	  interval: 300000,  // data refresh interval in ms
  },
},

Config Options

Option Description
interval Interval between new fetch of data from TimeTagger in ms
endpoint Your API TimeTagger endpoint, like this: http://mymachine:8080/timetagger/api/v2
apiToken Your API Token from TimeTagger

Testing

I have tested the Magic Mirror² TimeTagger module on an Raspberry Pi 3B with Raspberry OS and Node 16.15.0 and Magic Mirror² version 2.19.0.

Icons

The module uses the following icons from iconduck.com:

Software Stack

Magic Mirror²: https://magicmirror.builders

Preact: https://preactjs.com

HTM: https://github.com/developit/htm

Axios: https://axios-http.com/

License

MIT License

About

Magic Mirror² module that shows the latest hours tracked by TimeTagger.


Languages

Language:JavaScript 100.0%