k-0 / MMM-GoogleFit

A magic mirror module to grab google fit daily step count and daily weights.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MMM-GoogleFit

A magic mirror module to grab google fit daily step count and daily weights.

status

This module is not maintained and will not recieve any support from me.

What it Looks Like

Normal Usage:
Normal use screenshot


Colored Rings (each new color means 1x base step count):
Colored rings screenshot


NEW - Optional Icons (Now enabled by default)
Icons screenshot


Authentication Flow:
Authentication screenshot

Installing

This module is pretty simple to set up. You simply need to clone the module into your modules folder (like other modules).

$ cd MagicMirror/modules
$ git clone https://github.com/amcolash/MMM-GoogleFit.git

Then add the following to MagicMirror/config/config.js and optionally configure any options below.

{
    module: 'MMM-GoogleFit',
    position: 'position',
    config: {
        // If desired
    }
},

Finally, restart your magic mirror.

You will need to authenticate with google fit for this module to work. Follow the onscreen instructions which should tell you to visit https://google.com/device and input the code displayed. Simply enter the code and allow the module to access your google fit data. That's it!

Configuration Options

Below are listed all possible configuration options for this module.

SOME VALUES HAVE CHANGED SINCE THIS MODULE WAS FIRST PUBLISHED. CHECK YOUR CONFIG.

Note; If you want to use metric/imperial units for weights (or if they are not what you expect), please set the according units inside of your base config/config.js file as listed in the magic mirror instructions here.

Option Description
updateInterval How often to update (in minutes)
Possible values: number
Default value: 30
stepGoal How many steps you want to take each day (to fill pie chart)
Possible values: number
Default value: 10000
startOnMonday If the calendar view should start on Sunday (default) or Monday.
Possible values: boolean
Default value: false
lastSevenDays If the calendar view should show the last 7 days or if it should show the current week (default). Note: This setting takes priority over startOnMonday.
Possible values: boolean
Default value: false
reverseOrder Reverses the calendar view ordering - so the last day is on the left instead of the right.
Possible values: boolean
Default value: false
displayWeight If the module should show weight data.
Possible values: boolean
Default value: true
chartWidth How wide the chart portion of the module should be (in pixels), excludes icons
Possible values: number
Default value: 300
chartPadding Percent of available chart width dedicated to padding. If each ring takes 50px and there is 0.2 (percent) padding, then 10px are used for padding, making the chart 40px.
Possible values: number (between 0 - 1)
Default value: 0.2
innerThickness How thick inside gap of the chart rings should be (percent), where 0 = no innner gap and 1 = only gap, no visible chart.
Possible values: number (between 0 - 1)
Default value: 0.8
fontSize Font size
Possible values: number
Default value: 18
stepCountLabel Enable step count to be listed below the step rings
Possible values: boolean
Default value: false
useIcons Enable icons on the side of the module
Possible values: boolean
Default value: true
colors Array of colors for the step counter
Possible values: Array[#hexColor]
Default value: ["#EEEEEE", "#1E88E5", "#9CCC65", "#5E35B1", "#FFB300", "#F4511E"]
debug Turn on debug mode?
Possible values: boolean
Default value: false

Multiple Instances of the Module

This module can be used multiple times on the mirror (for different users) with some work, however this is not fully supported out of the box. Check out this github issue for instructions.

Libraries Used

This module (like most open source) has some help from others, shoutout to the authors and contributors! Cheers

  • Beautiful and responsive charts from HighCharts
  • Icons from the lovely people at icons8
  • Saving a json file (because it is easier) with jsonfile

About

A magic mirror module to grab google fit daily step count and daily weights.

License:MIT License


Languages

Language:JavaScript 100.0%