evanhsu / mmm-bring

A module for the MagicMirror that displays your Bring! shopping list.

MMM-Bring

A module for the MagicMirror² that displays your Bring! shopping list.

Features

• Touch Support
• Locale Support
• Auto-Layout

Installing

Step 1 - Install the module

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

Step 2 - Add module to ~MagicMirror/config/config.js

Add this configuration into config.js file's

{
    module: "MMM-Bring",
    position: "bottom_bar",
    config: {
       email: "[email protected]",
       password: "SECRET",
       updateInterval: 15, // in Minutes
       listName: "Zuhause", // optional
       showListName: true,
       activeItemColor: "#EE524F",
       latestItemColor: "#4FABA2",
       showLatestItems: false,
       maxItems: 0,
       maxLatestItems: 0,
       locale: "de-DE",
       useKeyboard: false,
       customHeader: "My shopping list", // optional
       listDropdown: true
    }
}

Updating

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

git pull
npm install

Configuring

Here is the configurable part of the module

Option	Description
email	Required Email-address.
password	Required password.
updateInterval	How often the module should load the list. Type: number in minutes Default value: 15
listName	The name of the list to be displayed. Type: string Default value: your default list
showListName	Flag for displaying list name. Type: boolean Default value: true
activeItemColor	Color for active items. Type: string Default value: #EE524F
latestItemColor	Color for recent items. Type: string Default value: #4FABA2
showLatestItems	Flag for displaying recently bought items. Type: boolean Default value: false
maxItems	Maximum items to display. Type: number Default value: 0 (all)
maxLatestItems	Maximum recent items to display. Type: number Default value: 0 (all)
locale	The locale. Type: string Default value: de-DE
useKeyboard	Activate to use this module together with MMM-Keyboard Type: boolean Default value: false
customHeader	Show the given text as generic module title Type: string Default value: undefined (empty)
listDropdown	If you have more than 1 list, show a dropdown where the list can be selected Type: boolean Default value: true

Valid locales

• de-AT
• de-CH
• de-DE
• es-ES
• en-GB
• en-US
• en-CA
• en-AU
• fr-CH
• fr-FR
• it-CH
• it-IT
• pt-BR
• nl-NL
• hu-HU
• nb-NO
• pl-PL
• ru-RU
• sv-SE
• tr-TR