MMM-ChoresMachine

What is due in your Chores Machine lists, on your MagicMirror².

Chores stay out of sight until they are due, so the mirror only shows what needs doing today, one line per chore, with whose turn it is. When nothing is due it says so and stays quiet.

What you need

• The Chores Machine app (iOS or Android) with Pro on your account. The feed is part of Pro.
• A link token: in the app, You → API access → Make a link. It is shown once and starts with cm_.

Install

cd ~/MagicMirror/modules
git clone https://github.com/Jhonte/MMM-ChoresMachine.git

No npm install needed: the module has no dependencies.

Update

cd ~/MagicMirror/modules/MMM-ChoresMachine
git pull

Then restart MagicMirror.

Configure

Add to the modules array in config/config.js:

{
  module: "MMM-ChoresMachine",
  position: "top_right",
  header: "Chores",
  config: {
    token: "cm_…"
  }
}

Option	Default	What it does
token	""	Your link token (required).
groups	[]	List ids to show. Empty shows every list your account is in.
view	"due"	"due", "upcoming" or "all".
showNextUp	true	The next chore coming in each list, under it.
showWho	true	Whose turn it is, or who a chore is for.
showListTitles	"auto"	List names as headings. "auto" shows them only with more than one list.
maxPerList	8	Chores per list before "+ N more". 0 for no cap.
strings	{}	Your own words for anything the module shows, by key. See below.
updateInterval	300000	How often to fetch, in ms (5 minutes). The API allows 600 requests an hour per token.

Language and wording

The module follows your mirror's language. English and Swedish are included (translations/). To change any line, or to fill in a language that is missing, set strings with the keys from translations/en.json. {n} is replaced with a number:

config: {
  token: "cm_…",
  strings: {
    allClear: "Nothing to do 🎉",
    dueDaysAgo: "{n} days late"
  }
}

With more than one list, each list shows its own name, so the module's header is hidden while chores are showing.

How it works

node_helper.js fetches GET https://choresmachine.com/api/v1/chores with your token, on the MagicMirror server, so the token is never sent to the browser. Due dates are counted in each list's own timezone by the API, the same way the app counts them.

If the link is removed in the app, or Pro lapses on the account that made it, the module says so instead of showing an old list.

License

MIT