Skip to content

Magic Mirror Module to display lists from Grocy Server.

License

Notifications You must be signed in to change notification settings

Bovive/MMM-GrocyLists

 
 

Repository files navigation

MMM-GrocyLists

This is a module for the MagicMirror².

Integrate with a Grocy server to display information from various widgets.

Installation

Setup the MagicMirror module

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

Updating

Go to the module’s folder inside MagicMirror modules folder and pull the latest version from GitHub and install:

git pull

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
    modules: [
        {
            module: 'MMM-GrocyLists',
            header: "Grocy", // Customize depending on Widget.
            config: {
                // See below for configurable options
            }
        }
    ]
}

Configuration options

Option Description
grocyURL Required URL of your Grocy instance. Do not include trailing /.

Type: string
grocyAPIKey Required API Key for your Grocy instance. Can be obtained off your instance at [Instance URL]/manageapikeys.

Type: string
widgetType Optional The type of Widget to render.

Type: string
Default chores
proxyCORS Optional Whether to use [cors-anywhere.herokuapp.com] to proxy for CORS purposes. Use if having trouble with API calls.

Type: boolean
Default false
updateInterval Optional How often to update the Module.

Type: int(milliseconds)
Default 300000 milliseconds (5 Minutes).
retryDelay Optional How long to wait to retry if error on API call.

Type: int(milliseconds)
Default 5000 milliseconds (5 minute).
tableClass Optional Class applied to the table. Controls sizing

string
Default small
choreFilter Optional Filters the number of days in the future to show chores. Zero for no filter.

int
Default 0
timeOffset Optional Offset the task due time by number of hours. May be used if your timezone is not being applied correctly. Zero for no offset.

int
Default 0
showOverdue Optional True to show overdue chores. False to hide them.

boolean
Default true

Widget Types

Currently only one widget type.

Chores

Show a list of upcoming chores due, or those overdue.

Thanks

About

Magic Mirror Module to display lists from Grocy Server.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 97.0%
  • CSS 3.0%