Skip to main content

Melimelo smart home integration, free and open source

Melimelo integration for Gladys Assistant

Tasks, shopping list, bin days and birthdays of your Melimelo household in Gladys.

This integration connects your Melimelo household — the family organizer app — to Gladys Assistant. Gladys sees your tasks, shopping list, bin collection days, birthdays and the household calendar, and can use them in scenes and on the dashboard.

It works through the cloud: Gladys reads the Melimelo API over the internet. Nothing is installed on your network.

It requires Gladys 5.3.0 or newer.

What you need​

  • The Melimelo API URL (an https://… address);
  • A personal access token of your household.

Both are provided by Melimelo. Today, Melimelo does not publish a public API yet: until it does, the integration cannot connect. It is ready to work as soon as Melimelo opens that access.

Setup​

  1. In Gladys, open Integrations, search for Melimelo and install it.
  2. In the Configuration screen of the integration:
    • paste the Melimelo API URL;
    • paste the access token (it is stored as a secret);
    • adjust the settings below if needed.
  3. Click Test the connection: the message names the household found and counts its tasks and items.
  4. Open Discovery: the device Melimelo – <household name> shows up. Add it to follow its values in Gladys.

Settings​

SettingDefaultWhat it does
Melimelo API URL—Address of the API. Only https is accepted.
Access token—Personal token of the household. Never shown nor logged.
Synchronization interval300 sHow often Melimelo is read (60 to 3600 s).
Bin reminder hour19Hour (0-23) from which "bins go out tomorrow" fires.
Event notice15 minLead time of "event about to start" (5 to 240 min).
Time zoneEurope/ParisTells what "today" and "tomorrow" are.

The "Household" device​

One read-only device per household:

ValueExample
Open tasks4
Overdue tasks1
Shopping list items7
Today's events2
Days until the next collection1
Next bin collectionYellow bin
Days until the next birthday9
Next birthdayGranny (80)

Use them in scene conditions, e.g. "if there are overdue tasks, send a message".

Scenes​

Triggers​

KeyWhenVariables
task_dueAn open task is due todaytitle, assignee, due_date
garbage_collection_tomorrowThe day before a collection, from the reminder hour (type filter)type, label, date
birthday_todayOn the day of a birthdayname, age
shopping_item_addedA household member adds an item (never Gladys)item, quantity, added_by
event_starting_soonA calendar event starts soon (all-day events excluded)title, start_time, location, minutes

Each trigger fires only once per task, collection, birthday or event, even if the integration restarts. Use the variables in the following actions, e.g. {{triggerEvent.data.title}}.

Triggers are checked at every synchronization: with a 300 s interval, an event may be announced up to 5 minutes later than the chosen notice.

Actions​

KeyWhat it doesOutput
add_shopping_itemAdds an item to the shopping listadded
create_taskCreates a task (optional YYYY-MM-DD due date)task_id
complete_taskCompletes the open task with this titlecompleted (false if missing)
sync_nowReads Melimelo right awaytasks_open, shopping_items

Example: "When the fridge sensor sees the door open for more than 2 minutes, add 'Check the fridge' to the tasks."

Dashboard​

The Melimelo household widget shows:

  • the number of tasks, items to buy and today's events;
  • one list of your choice (widget setting): tasks, shopping, agenda or bin days;
  • the connection, the time of the last sync, the next collection and the next birthday;
  • the buttons Add to shopping (a small form), Synchronize and Open Melimelo.

Troubleshooting​

MessageWhat to do
"Fill in the Melimelo API URL…"Fill in the URL and the token in the configuration.
"Melimelo refused the access token"Create a new token and paste it.
"The Melimelo API does not know…"Check the API URL.
"Melimelo cannot be reached"Check the URL and the internet connection of Gladys.
"Melimelo asks to slow down"Raise the synchronization interval.

The integration logs are in Gladys Settings → System (container logs). The token never appears there.

Privacy​

The integration only talks to the Melimelo API you configured. The household data stays in Gladys. Only a short list of the triggers already sent is kept on disk (/data), 45 days at most.

Configuration settings​

These are the settings Melimelo asks for in its configuration screen in Gladys.

SettingTypeRequiredDescription
Getting startedsectionNoThis integration reads your Melimelo household from the Melimelo cloud: open tasks, shopping list, bin collection days, birthdays and the calendar. It needs the address of the Melimelo API and a personal access token of your household, both provided by Melimelo. Nothing is installed on your network.
Melimelo API URLstringYesThe address of the Melimelo API, given by Melimelo. Only https addresses are accepted.
Access tokensecretYesThe personal access token of your household. It is stored as a secret and only sent to the Melimelo API.
Synchronization interval (s)numberNoHow often Melimelo is read, in seconds (60 to 3600). The scene triggers are checked at the same pace.
Bin reminder hournumberNoFrom this hour (0 to 23), the day before a collection, the "bins go out tomorrow" trigger fires.
Event notice (min)numberNoHow many minutes before a calendar event the "event about to start" trigger fires (5 to 240).
Time zonestringNoThe time zone of the household, used to know what "today" and "tomorrow" are (IANA name, e.g. Europe/Paris).

How to install Melimelo in Gladys​

  1. In Gladys, open Integrations: Melimelo appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/prohand/gladys-melimelo:1.0.2), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration).
  3. Open the Configuration screen of the integration, fill in the settings, and save.
  4. You can also install it directly from its repository URL: https://github.com/prohand/gladys-melimelo.

Melimelo requires Gladys >=5.3.0. The catalog inside Gladys refreshes every hour, so a new version becomes available at most one hour after its release.

Not running Gladys yet? It is free and open source: follow the installation guide to get started.

About external integrations​

Melimelo is an external integration: a community integration packaged as a Docker container and published on GitHub, that Gladys installs in one click and runs in a sandbox isolated from its core. It is published and maintained by prohand, not by the Gladys core team.

Subscribe to the Gladys Assistant newsletter

A few emails per month about new releases and project news. Sent by Pierre-Gilles Leymarie, founder of the project. Unsubscribe anytime 🙂