Skip to main content

GareSNCF smart home integration, free and open source

GareSNCF integration for Gladys Assistant

Searches SNCF stations and tracks multiple timetables and delays.

View on GitHubAll integrations

GareSNCF connects Gladys to the official SNCF API (Navitia API). Station search is integrated into Gladys device discovery so users can select and follow several stations.

Get a token and add stations​

  1. Request a free developer token from the SNCF API portal.
  2. In the integration configuration, enter the API token and a station or city name in Search for stations.
  3. Save the configuration, open Discovery, and scan for devices. Matching stations appear as selectable devices.
  4. Select every station you want to follow and add them to Gladys. To follow stations in other cities, change the search and scan again; stations already added remain tracked.
  5. Set the refresh interval per station and the delay threshold that triggers scenes.
  6. Use the Followed stations widget to review tracked devices. To stop following a station, delete its device from the Gladys devices list. Repeated searches do not create duplicates because SNCF station IDs are stable keys.

API usage is shared across the integration. The default interval is 10 minutes per station. Cancellation detection is enabled by default and adds one request for the theoretical timetable per refresh; disable it in the integration settings to reduce API usage. Increase the refresh interval if you follow many stations.

Optional global filters match line/train code, destination and transport type. They apply to boards, sensors and scenes; each board widget can also set its own display filters. On HTTP 429, the widget keeps the last received data and shows the error and retry delay when SNCF provides one. The API does not expose the remaining quota here.

Widget​

Add Followed stations to review tracked devices, or SNCF station board to display one station. The board shows train times, countdowns, available platforms, delays and cancellations reported by the API. It can be limited to three trains in compact view. Its status shows data freshness and refresh errors; Refresh queries the API immediately.

Scene trigger and action​

The Delayed train, Cancelled train and Platform change triggers can be filtered by station. The latter two use information returned by SNCF and changes compared between refreshes. Variables include the station, train, destination, delay, time and platform (plus the previous platform on a platform change).

The Get upcoming trains action lets you choose one of your added stations. It forces a refresh and returns count, next_train, destination, minutes, platform, delay_minutes and cancelled to later scene steps.

Data and privacy​

The token is stored in the GareSNCF configuration and sent to api.sncf.com in the Basic Authentication header. It is never included in the URL or logs. Train schedules and real-time details are provided by SNCF and may be missing or change.

Configuration settings​

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

SettingTypeRequiredDescription
SNCF APIsectionNoA free token is required. Request one at numerique.sncf.com/startup/api/token-developpeur/.
SNCF API tokensecretYesYour personal SNCF token. It is passed to the container and must not be shared.
Search for stationsstringYesEnter a station or city name, then scan to select one or more stations.
Displayed boardselectNo
Refresh interval (seconds)numberNo
Delay threshold for scene trigger (minutes)numberNo
Filter by line or train code (optional)stringNoLeave empty to show all results.
Filter by destination (optional)stringNoLeave empty to show all results.
Filter by transport type (optional)stringNoLeave empty to show all results.
Trigger a scene when a train is cancelledbooleanNo
Trigger a scene when the platform changesbooleanNo

How to install GareSNCF in Gladys​

  1. In Gladys, open Integrations: GareSNCF appears in the catalog, next to the native integrations, with a community badge.
  2. Click Install. Gladys pulls the Docker image (ghcr.io/quentin-cs/gladysgaresncf:2.1.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/Quentin-CS/GladysGareSNCF.

GareSNCF 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​

GareSNCF 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 Quentin-CS, 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