MMM-flatastic

An integration of the flatastic home / commune management app for the MagicMirror²

If yoink some of this code, I would like to be credited :)

Description

This is an implementation of the flatastic WG-App for the MagicMirror Project.

The flatastic app is for people who share appartments. You can use it to document what needs done when, to manage your finances and more.

---

NOTE

This project and the author of this project do not have any ties with the flatastic app or the company behind the app.

---

You can display the following:

• Tasks, sorted by urgency
• Statistics / Ranking for chore points
• Statistics / Ranking for cashflow (sorted by chore points)

Currently, the module is only available in german. (If you'd like to change that, see section Contributing

Some of the code was taken from Robin Glauser, Thank you!

Screenshot

Installation

Run these commands at the root of your magic mirror install.

cd modules
git clone https://github.com/joschi27/MMM-flatastic

If you get the error "Warning could not load config file. Starting with default configuration. Error found : Cannot find module 'request'": run

cd MMM-flatastic
npm install

Using the module

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

    modules: [{
            module: 'MMM-flatastic',
            position: 'bottom_left',
            config: {
                updateInterval: 300 * 1000, // update time in milliseconds -> updates every 5 minutes
                apiKey: "{{PLEASE FOLLOW GUIDE IN README.MD}}",
                taskListConfig: { show: false },
                statisticsConfig: { show: true, showMoney: true, showChorePoints: true },
            }
        },
        {
            module: 'MMM-flatastic',
            position: 'bottom_right',
            config: {
                updateInterval: 60 * 1000, // update time in milliseconds -> updates every minute
                apiKey: "{{PLEASE FOLLOW GUIDE IN README.MD}}",
                taskListConfig: { show: true, maxDisplayItems: 5, showOptionalChores: true },
                statisticsConfig: { show: false },
            }
        },

This creates two instances of the flatastic module. One displays the statistics, and one displays the task list. You can also display everything in one module, but that can really fill up your screen quickly. The positioning of the different modules is up to you; check out the MagicMirror documentation

How to get your apiKey (to insert in config)

Dont share this key with anyone!

• Go over to the flatastic web-app at https://www.flatastic-app.com/webapp/
• Open the developer options on your browser
• Go to the network tab
• (Reload the browser if nothing is displayed)
• Find any request that goes to API
• Search for the x-api-key field in the request headers
• Insert the value in the module config.js file.

Developer information

Current state of the project

Completed / Maintaining / Improving depending on free time

Contributing

You are very welcome to contribute!

TODO's:

• Translations
• An option to scroll through any lists that are too long to display on the MM (-> the chore list can be very long and will overflow if not limited, so slowly scrolling through / pagination switch could be implemented.)
• Display of Shopping List
• Display of Bulletin Board
• Dark mode (css work)
• Design overhaul if somebody is a better designer than me :P

API

The project is based on the undocumented flatastic API (https://api.flatastic-app.com/index.php/api). I have no idea if there are rate limits or similar, so use at your own discretion, and make sure that the update timer is not too high. The updateInterval counts for every module individually, and in the current state, every update cycle makes 4 requests to the api! Caching is also not supported yet. (See contributing if you'd like to fix that.)

Configuration options

The following properties can be configured:

It is important to note that you can have multiple instances of this module on your screen (as shown in the default configuration above). The configuration that's global for all modules (like the apiKey) will be taken from the first module.

Option	Description
apiKey	Sets the API key for the module to connect to flatastic. This value is MANDATORY Default value: 'none' (60 Seconds)
updateInterval	Sets the time in milliseconds to update the module. This value is OPTIONAL Default value: '60000' (60 Seconds)
taskListConfig	Sets the configuration for the task list. Values: show (true / false) -> Sets if the module should display the task list. maxDisplayItems (number from 1 to infinity (don't quote me on this)) -> Sets how many chores the module should display. showOptionalChores (true / false) -> Sets wether optional chores (the ones that can be done whenever) should be displayed in the tasklist. This value is OPTIONAL Default values: '{ show: true, maxDisplayItems: 10, shopOptionalChores: true }'
statisticsConfig	Sets the configuration for the statistics. Values: show (true / false) -> Sets if the module should display the statistics list. showMoney (true / false) -> Sets whether the money owed is displayed. showChorePoints (true / false) -> Sets whether the chore points are displayed. This value is OPTIONAL Default values: '{ show: true, showMoney: true, showChorePoints: true }
animationSpeed	Sets the time in milliseconds to animate module updates. This value is OPTIONAL and setting it could lead to funny glitches :P Default value: '0'