Skip to main content

Wallos smart home integration, free and open source

Wallos integration for Gladys Assistant

Your Wallos subscriptions in Gladys: monthly cost, next payments and reminders.

View on GitHubAll integrations

Bring your subscriptions into Gladys: what they cost per month and per year, the next payments, and a reminder before each one, read from your own Wallos, the self-hosted subscription tracker.

The integration only reads: it never writes to Wallos, never adds nor changes a subscription. It talks to your Wallos directly on your network, with your API key. Not affiliated with Wallos.

What you get​

  • A Wallos device: monthly cost and estimated yearly cost of your active subscriptions (in your main currency), number of active subscriptions, days before the next payment and its name.
  • One device per active subscription: price of one payment, days before the next payment, and its date.
  • A dashboard widget: the monthly and yearly cost, then the next 8 payments.
  • A scene trigger: a payment due today, tomorrow, in 3 or 7 days.
  • A scene action: read the payments of the next 7, 14 or 31 days, as a sentence to send by message or have read aloud.

Requirements​

  • Gladys Assistant 5.1 or later.
  • Wallos (tested with 5.10.0), reachable from the Gladys host (same network, VPN or a public address).
  • The API key of your Wallos user.

Configuration​

Finding the API key​

  1. In Wallos, open your Profile (the menu under your avatar).
  2. The API Key section shows your key: copy it whole.

The key gives access to every subscription of your user: keep it as secret as your password. The integration sends it in the body of its requests, never in the address, so it does not show in the logs of a reverse proxy.

Settings​

SettingWhat it does
Address of WallosThe address you open Wallos with, e.g. http://192.168.1.20:8282 or https://subs.my.home
API keyThe key copied above
Accept a self-signed certificateOnly for an https address whose certificate you made yourself
Refresh interval15 or 30 minutes, 1 hour (default), 3 or 6 hours
Language of the textsNames of the features (at their creation) and sentences of the scenes

Save, then click Test the connection: the answer gives the version of Wallos, the number of active subscriptions and their monthly cost. Then open the Discover tab and add the Wallos device and the subscriptions you want to follow in Gladys.

Devices​

DeviceFeatures
WallosMonthly cost, Estimated yearly cost, Active subscriptions, Days before the next payment, Next payment (name and date)
SubscriptionPrice, Days before payment, Next payment date

The monthly cost is computed like the statistics page of Wallos: a weekly payment counts 4.35 times a month, a yearly one a twelfth, a one-time payment nothing; prices in another currency are converted with the exchange rates of Wallos (set them up in Wallos with a Fixer key, otherwise they count 1 for 1). The yearly cost is twelve times the monthly cost.

Amounts in euros, dollars or pounds show their unit; another currency is added to the device name (Gym (CHF)). Only active subscriptions are listed. When the payment date of a subscription is past (auto renewal off), the date stays but the day count is no longer updated: it keeps its last value.

To be warned when the monthly cost goes over a threshold, use the standard trigger of Gladys "Device state change" on the Monthly cost of the Wallos device, with the condition "greater": no need for a trigger of the integration.

Dashboard widget​

Wallos: next payments shows the monthly and estimated yearly cost, then the next 8 payments, soonest first: the subscription, its price and date, and a badge "today" in red, "tomorrow" or within 3 days in orange. Tap a payment to see its category. The footer gives the time of the last reading. It covers every active subscription of Wallos, added in Gladys or not.

Scene trigger​

Wallos: payment due soon: a payment of an active subscription is due today, tomorrow, in 3 or 7 days (choose one). Leave Subscription empty to be warned for all of them, or choose one subscription added in Gladys (not the Wallos device, which never matches). It fires once per subscription and payment date, on that day, at the first reading of the day. Variables: name of the subscription, price, currency, payment date (YYYY-MM-DD) and a ready-made sentence.

What was fired is kept in the integration's data: a restart fires nothing twice.

Scene action​

Wallos: read the next payments: the payments of the next 7, 14 or 31 days, soonest first, with their price, then the total in your main currency. Outputs: text, count, total.

The action reads Wallos again when the last reading is older than the refresh interval.

Scene examples​

  • Reminder before a payment: trigger "payment due soon", 3 days, every subscription; action: send a message with {{triggerEvent.data.text}}.
  • Monday morning brief: every Monday at 8 am, action "read the next payments", 7 days, then have its text read aloud by the speaker of the kitchen.
  • Budget watch: trigger "Device state change" on the monthly cost, greater than 100; action: notify the family on Telegram.

Privacy and data​

  • The integration reads Wallos and never writes to it.
  • The API key is stored by Gladys like any secret setting, and never written to the logs.
  • The logs never hold an amount, a subscription name or the address of Wallos, even at debug level: only counts, identifiers and day counts.
  • Subscription names become device names, which you can rename.
  • The integration's data volume only keeps which reminders were sent (identifiers and dates).

Troubleshooting​

MessageWhat to do
Wallos refuses the API keyThe key was copied partly, or belongs to another Wallos: copy it again from Profile → API Key
Wallos does not answerCheck the address from the Gladys host (port, http/https), and that Wallos is up
The certificate of Wallos is not trustedUse the http address on your network, or enable "Accept a self-signed certificate"
This address does not answer like the APIThe address leads to another page (a login portal, a reverse proxy): give Wallos's own one
A device has no valueAdd it in the Discover tab: only the devices added get states

The logs of the integration (Integrations → Wallos → logs) say what happened; set LOG_LEVEL=debug for more detail.

Limits​

  • Read only: no subscription can be added or changed from Gladys.
  • One Wallos, one user (the one of the API key); the other members of a household are not read separately.
  • Payment dates are the ones Wallos keeps: Wallos moves them forward once a day by its own task.
  • The reminder fires at the first reading of the day: up to one refresh interval after midnight.
  • Tested against a real Wallos 5.10.0 in Docker, not yet on a Gladys installation with a real Wallos: feedback welcome.

Configuration settings​

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

SettingTypeRequiredDescription
Connection to WallossectionNoIn Wallos, open Profile, copy your API key and paste it below with the address of Wallos. Then add the Wallos device and the subscriptions you want in the Discover tab.
Address of WallosstringYesThe address you open Wallos with, reachable from Gladys.
API keysecretYesWallos → Profile → API key. Read only: the integration never writes to Wallos. Stored by Gladys, never written to the logs.
Accept a self-signed certificatebooleanNoOnly for an https address whose certificate you made yourself.
Refresh intervalselectNoHow often Wallos is read. Subscriptions change rarely: one hour is plenty.
Language of the textsselectNoNames of the features (at their creation) and texts sent to the scenes.

How to install Wallos in Gladys​

  1. In Gladys, open Integrations: Wallos appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/guim31/gladys-wallos:1.0.1), 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/guim31/gladys-wallos.

Wallos requires Gladys >=5.1.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​

Wallos 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 guim31, 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 🙂
Last updated on