Que faire à Paris smart home integration, free and open source
Outings from the City of Paris agenda: event counts, next event, widget and alerts.
Published by guim31
- Devices
- Version 1.0.0
- Requires Gladys >=5.3.0
- ★ 0
The outings of the official agenda of the City of Paris, "Que faire à Paris ?": concerts, shows, exhibitions, talks, workshops, walks, for children or not, free or not. Around your house, in the arrondissements you choose or in the whole of Paris: how many events today, this weekend and in the next 7 days, and the next one to come. No account, no key.
Unofficial integration, not affiliated with the City of Paris. Built on the model of the Toulouse Agenda integration.
What you get
- One device per zone: around the house located in Gladys (500 m to 5 km), the whole agenda, or any of the 20 arrondissements.
- For each zone: the number of events today, this weekend and in the next 7 days, and the next event (title, place, date).
- Your filters apply everywhere: themes, keywords, free events only, events for children, exhibitions and long runs included or not.
- A widget "Outings in Paris": the next events of your zones, with date, place and a "Free" badge; a tap shows the description and the link to paris.fr.
- Two scene triggers: a new event is announced, an event starts today.
- A scene action: what to do this weekend (or tonight, tomorrow…) in one sentence, ready to send or to say.
Requirements
- Gladys Assistant 5.3.0 or later.
- Internet access from Gladys (the agenda is read from opendata.paris.fr).
- For the "Around the house" zone: the house located in Gladys (Settings → Houses).
Installation
In Gladys, Integrations → Install from GitHub, then enter the address of the repository:
https://github.com/guim31/gladys-que-faire-a-paris.
Configuration
Settings
- Zones: tick "Around the house", "All of Paris" and/or arrondissements. Each zone becomes a device offered in the Discover tab.
- Around the house: the radius around the house (500 m, 1 km, 2 km, 5 km).
- Themes: music, show, exhibition, cinema, talk, workshop, walk, sport, festival. Nothing ticked: every theme. They come from the tags of the agenda.
- Keywords: comma-separated; an event matches when its title, place, street or tags contain one of them (whole words, accents and case ignored).
- Free events only: "free under conditions" included.
- Audience: everyone, or events for children (tag "Enfants" or a children audience).
- Include exhibitions and long runs: events with more than 7 dates or one date over more than 14 days (a permanent exhibition, a weekly class). Off by default, so the counts stay meaningful.
- Language of names and messages: feature names, trigger texts and the scene sentence. The widget follows the language of each user.
Add zones
Save, open the Discover tab of the integration and add the zones you want. Changing the filters later updates the counts of the zones already added; no need to add them again.
Check
The Check button shows the last download of the agenda, the zones offered and added, and the counts of each zone.
Devices
Each zone has six features, all read-only:
| Feature | Type | Content |
|---|---|---|
| Events today | counter | dates still to come or running today |
| Events this weekend | counter | from Friday 18:00 to Sunday midnight |
| Events in the next 7 days | counter | from now to the end of the 7th day |
| Next event | text | the title of the next date to start |
| Place of the next event | text | its venue and address |
| Date of the next event | text | "tomorrow, 18:30", "Sat 31 Oct, 20:00" |
Dashboard widget
Outings in Paris lists the next events of your zones (all of them, or the ones you pick), 8 at most, soonest first: title, date and venue, "Free" badge. Settings: the period (today, tonight, tomorrow, this weekend, next 7 days, next 30 days), show or hide the period and count line, show or hide the "Free" badge.
Scene triggers
- New event announced: an event never seen before, matching your filters, appears in a followed zone (checked at each download).
- Event starting today: every morning around 8 (by 8:10), for each event of a followed zone with a date starting that day.
Both can be filtered by zone, main theme and price, and give the zone, title, date, place, theme, price, description, link and start time as variables.
Scene action
What to do in Paris returns one sentence, for example "This weekend: 34 events, including X (Sat 31 Oct, 20:00, Le Trianon), Y (…) and 31 more.", the number of events, and the title and link of the first one. Fields: zones, period (this weekend by default), number of events named (1 to 10).
Scene examples
- Every Friday at 18:00, send the sentence of "What to do in Paris" (this weekend, free events) on Telegram.
- When an event starts today around the house and its theme is "Music", send a notification with its title and link.
- Continue only if the number of events of the weekend is greater than 0.
Data and refresh
- Source: the dataset Que faire à Paris ? of the City of Paris, Open Database License (ODbL), about 3,300 events, updated daily.
- The agenda is downloaded every 8 hours (three times a day at most, about 1.2 MB compressed), and the counts are computed again every 10 minutes without any download. A failed download is tried again one hour later; the last known events are kept meanwhile.
- The dates of the dataset carry a wrong time offset: the integration reads them as Paris times.
- 50 scene events per pass at most (Gladys takes 300 a minute): the house first, then the arrondissements, then all of Paris, soonest first in each zone.
- What was already announced is kept in
/data, so a restart announces nothing twice.
Troubleshooting
- No "Around the house" zone in the Discover tab: locate the house in Gladys, then save the configuration again. The Check button says it.
- All counts at 0: your filters may be too narrow (a keyword, free only, children), or the agenda could not be downloaded yet: see Check and the logs.
- "No recent value": Gladys did not receive states for 48 hours: the integration is stopped or cannot reach Gladys.
- More detail in the logs with
LOG_LEVEL=debug.
Limitations
- Only the events published in "Que faire à Paris ?": not every venue of Paris publishes there. A few events are in the suburbs; "All of Paris" includes them.
- Events without coordinates are not counted around the house; events without a Paris postcode are not in any arrondissement.
- Titles, places and descriptions stay in French, as published.
- The widget shows 8 events at most (limit of Gladys).
Credits
- Data: City of Paris, "Que faire à Paris ?", Open Database License (ODbL).
- Structure and filters adapted from the Toulouse Agenda integration (guim31/gladys-toulouse-agenda).
Configuration settings
These are the settings Que faire à Paris asks for in its configuration screen in Gladys.
| Setting | Type | Required | Description |
|---|---|---|---|
| How it works | section | No | The events come from "Que faire à Paris ?", the agenda of the City of Paris, in open data: free, no account. Choose your zones and filters, save, then add the zones from the Discover tab. |
| Zones | multi_select | No | One device per zone, offered in the Discover tab. Around the house: needs the house located in Gladys. |
| Around the house | select | No | Distance from the house of the "Around the house" zone. |
| Themes | multi_select | No | Nothing ticked: every theme. |
| Keywords | string | No | Comma-separated, any of them (title, place, tags). Empty: no filter. |
| Free events only | boolean | No | Free under conditions included. |
| Audience | select | No | |
| Include exhibitions and long runs | boolean | No | Events with more than 7 dates or over more than 14 days. |
| Language of names and messages | select | No | Feature names are fixed when a zone is added. Events stay in French, as published. |
How to install Que faire à Paris in Gladys
- In Gladys, open Integrations: Que faire à Paris appears in the catalog, next to the native integrations, with a community badge.
- Click Install. Gladys pulls the Docker image (
ghcr.io/guim31/gladys-que-faire-a-paris:1.0.0), starts it in a sandbox isolated from the core, and generates the integration's interface (devices, discovery and configuration). - Open the Configuration screen of the integration, fill in the settings, and save.
- You can also install it directly from its repository URL: https://github.com/guim31/gladys-que-faire-a-paris.
Que faire à Paris 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
Que faire à Paris 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.
- Browse all integrations, native and community
- Build and publish your own external integration
- Source code on GitHub — source of this documentation