MMM-GrocyLists

This is a module for the MagicMirror².

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

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

Widget Types

Currently only one widget type.

Chores

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

Thanks

• Built with MagicMirror Module Template